From b71428a0a5bd67d2cfdcfe31e9601e99d8132e35 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Linus=20F=C3=A4rnstrand?= <linus@mullvad.net>
Date: Fri, 19 Jul 2024 15:08:01 +0200
Subject: [PATCH] Improve documentation on DOCS_RS workaround

---
 nftnl-sys/build.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/nftnl-sys/build.rs b/nftnl-sys/build.rs
index abd5eab..dfb653a 100644
--- a/nftnl-sys/build.rs
+++ b/nftnl-sys/build.rs
@@ -26,7 +26,9 @@ fn get_env(var: &'static str) -> Option<PathBuf> {
 }
 
 fn main() {
-    // Do NOT link when building documentation on docs.rs
+    // Do NOT link when building documentation on docs.rs. The native libraries are not
+    // present on their build machines and just makes the compilation fail. Documentation
+    // generation will work without linking.
     if std::env::var("DOCS_RS").is_ok() {
         return;
     }