docs: don't download the tldr archive (#3415)

The ureq dependency is causing compilation errors on various platforms (see #3184, #3216, #3375). Hence we remove that dependency and do not automatically download the archive anymore. Instead, we ask the user to download it separately when the archive is not found.

Cargo.lock

@@ -73,12 +73,6 @@ version = "1.0.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a"
 
-[[package]]
-name = "base64"
-version = "0.13.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "904dfeac50f3cdaba28fc6f57fdcddb75f49ed61346676a78c4ffe55877802fd"
-
 [[package]]
 name = "bigdecimal"
 version = "0.3.0"
@@ -173,12 +167,6 @@ dependencies = [
  "regex-automata",
 ]
 
-[[package]]
-name = "bumpalo"
-version = "3.9.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a4a45a46ab1f2412e53d3a0ade76ffad2025804294569aae387231a0cd6e0899"
-
 [[package]]
 name = "byte-unit"
 version = "4.0.14"
@@ -240,12 +228,6 @@ dependencies = [
  "winapi 0.3.9",
 ]
 
-[[package]]
-name = "chunked_transfer"
-version = "1.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fff857943da45f546682664a79488be82e69e43c1a7a2307679ab9afb3a66d2e"
-
 [[package]]
 name = "clang-sys"
 version = "1.3.0"
@@ -347,7 +329,6 @@ dependencies = [
  "time",
  "unindent",
  "unix_socket",
- "ureq",
  "users",
  "uu_arch",
  "uu_base32",
@@ -838,16 +819,6 @@ version = "1.0.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
 
-[[package]]
-name = "form_urlencoded"
-version = "1.0.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5fc25a87fa4fd2094bffb06925852034d90a17f0d1e05197d4956d3555752191"
-dependencies = [
- "matches",
- "percent-encoding",
-]
-
 [[package]]
 name = "fs_extra"
 version = "1.2.0"
@@ -968,17 +939,6 @@ version = "2.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
 
-[[package]]
-name = "idna"
-version = "0.2.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "418a0a6fab821475f634efe3ccc45c013f742efe03d853e8d3355d5cb850ecf8"
-dependencies = [
- "matches",
- "unicode-bidi",
- "unicode-normalization",
-]
-
 [[package]]
 name = "if_rust_version"
 version = "1.0.0"
@@ -1019,15 +979,6 @@ dependencies = [
  "either",
 ]
 
-[[package]]
-name = "js-sys"
-version = "0.3.56"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a38fc24e30fd564ce974c02bf1d337caddff65be6cc4735a1f7eab22a7440f04"
-dependencies = [
- "wasm-bindgen",
-]
-
 [[package]]
 name = "keccak"
 version = "0.1.0"
@@ -1105,12 +1056,6 @@ version = "0.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "ffbee8634e0d45d258acb448e7eaab3fce7a0a467395d4d9f228e3c1f01fb2e4"
 
-[[package]]
-name = "matches"
-version = "0.1.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a3e378b66a060d48947b590737b30a1be76706c8dd7b8ba0f2fe3989c68a853f"
-
 [[package]]
 name = "md-5"
 version = "0.10.1"
@@ -1399,12 +1344,6 @@ version = "0.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "19b17cddbe7ec3f8bc800887bab5e717348c95ea2ca0b1bf0837fb964dc67099"
 
-[[package]]
-name = "percent-encoding"
-version = "2.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e"
-
 [[package]]
 name = "phf"
 version = "0.10.1"
@@ -1668,21 +1607,6 @@ version = "0.1.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "53552c6c49e1e13f1a203ef0080ab3bbef0beb570a528993e83df057a9d9bba1"
 
-[[package]]
-name = "ring"
-version = "0.16.20"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3053cf52e236a3ed746dfc745aa9cacf1b791d846bdaf412f60a8d7d6e17c8fc"
-dependencies = [
- "cc",
- "libc",
- "once_cell",
- "spin",
- "untrusted",
- "web-sys",
- "winapi 0.3.9",
-]
-
 [[package]]
 name = "rlimit"
 version = "0.8.3"
@@ -1708,18 +1632,6 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
 
-[[package]]
-name = "rustls"
-version = "0.20.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b323592e3164322f5b193dc4302e4e36cd8d37158a712d664efae1a5c2791700"
-dependencies = [
- "log",
- "ring",
- "sct",
- "webpki",
-]
-
 [[package]]
 name = "rustversion"
 version = "1.0.6"
@@ -1741,16 +1653,6 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
 
-[[package]]
-name = "sct"
-version = "0.7.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d53dcdb7c9f8158937a7981b48accfd39a43af418591a5d008c7b22b5e1b7ca4"
-dependencies = [
- "ring",
- "untrusted",
-]
-
 [[package]]
 name = "selinux"
 version = "0.2.7"
@@ -1873,12 +1775,6 @@ dependencies = [
  "winapi 0.3.9",
 ]
 
-[[package]]
-name = "spin"
-version = "0.5.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6e63cff320ae2c57904679ba7cb63280a3dc4613885beafb148ee7bf9aa9042d"
-
 [[package]]
 name = "stable_deref_trait"
 version = "1.2.0"
@@ -2051,33 +1947,12 @@ dependencies = [
  "winapi 0.3.9",
 ]
 
-[[package]]
-name = "tinyvec"
-version = "1.5.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2c1c1d5a42b6245520c249549ec267180beaffcc0615401ac8e31853d4b6d8d2"
-dependencies = [
- "tinyvec_macros",
-]
-
-[[package]]
-name = "tinyvec_macros"
-version = "0.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c"
-
 [[package]]
 name = "typenum"
 version = "1.15.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "dcf81ac59edc17cc8697ff311e8f5ef2d99fcbd9817b34cec66f90b6c3dfd987"
 
-[[package]]
-name = "unicode-bidi"
-version = "0.3.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1a01404663e3db436ed2746d9fefef640d868edae3cceb81c3b8d5732fda678f"
-
 [[package]]
 name = "unicode-linebreak"
 version = "0.1.2"
@@ -2087,15 +1962,6 @@ dependencies = [
  "regex",
 ]
 
-[[package]]
-name = "unicode-normalization"
-version = "0.1.19"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d54590932941a9e9266f0832deed84ebe1bf2e4c9e4a3554d393d18f5e854bf9"
-dependencies = [
- "tinyvec",
-]
-
 [[package]]
 name = "unicode-segmentation"
 version = "1.9.0"
@@ -2136,41 +2002,6 @@ dependencies = [
  "libc",
 ]
 
-[[package]]
-name = "untrusted"
-version = "0.7.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a156c684c91ea7d62626509bce3cb4e1d9ed5c4d978f7b4352658f96a4c26b4a"
-
-[[package]]
-name = "ureq"
-version = "2.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9399fa2f927a3d327187cbd201480cee55bee6ac5d3c77dd27f0c6814cff16d5"
-dependencies = [
- "base64",
- "chunked_transfer",
- "flate2",
- "log",
- "once_cell",
- "rustls",
- "url",
- "webpki",
- "webpki-roots",
-]
-
-[[package]]
-name = "url"
-version = "2.2.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a507c383b2d33b5fc35d1861e77e6b383d158b2da5e14fe51b83dfedf6fd578c"
-dependencies = [
- "form_urlencoded",
- "idna",
- "matches",
- "percent-encoding",
-]
-
 [[package]]
 name = "users"
 version = "0.10.0"
@@ -3257,89 +3088,6 @@ version = "0.10.2+wasi-snapshot-preview1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "fd6fbd9a79829dd1ad0cc20627bf1ed606756a7f77edff7b66b7064f9cb327c6"
 
-[[package]]
-name = "wasm-bindgen"
-version = "0.2.79"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "25f1af7423d8588a3d840681122e72e6a24ddbcb3f0ec385cac0d12d24256c06"
-dependencies = [
- "cfg-if 1.0.0",
- "wasm-bindgen-macro",
-]
-
-[[package]]
-name = "wasm-bindgen-backend"
-version = "0.2.79"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8b21c0df030f5a177f3cba22e9bc4322695ec43e7257d865302900290bcdedca"
-dependencies = [
- "bumpalo",
- "lazy_static",
- "log",
- "proc-macro2",
- "quote 1.0.14",
- "syn",
- "wasm-bindgen-shared",
-]
-
-[[package]]
-name = "wasm-bindgen-macro"
-version = "0.2.79"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2f4203d69e40a52ee523b2529a773d5ffc1dc0071801c87b3d270b471b80ed01"
-dependencies = [
- "quote 1.0.14",
- "wasm-bindgen-macro-support",
-]
-
-[[package]]
-name = "wasm-bindgen-macro-support"
-version = "0.2.79"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bfa8a30d46208db204854cadbb5d4baf5fcf8071ba5bf48190c3e59937962ebc"
-dependencies = [
- "proc-macro2",
- "quote 1.0.14",
- "syn",
- "wasm-bindgen-backend",
- "wasm-bindgen-shared",
-]
-
-[[package]]
-name = "wasm-bindgen-shared"
-version = "0.2.79"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3d958d035c4438e28c70e4321a2911302f10135ce78a9c7834c0cab4123d06a2"
-
-[[package]]
-name = "web-sys"
-version = "0.3.56"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c060b319f29dd25724f09a2ba1418f142f539b2be99fbf4d2d5a8f7330afb8eb"
-dependencies = [
- "js-sys",
- "wasm-bindgen",
-]
-
-[[package]]
-name = "webpki"
-version = "0.22.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f095d78192e208183081cc07bc5515ef55216397af48b873e5edcd72637fa1bd"
-dependencies = [
- "ring",
- "untrusted",
-]
-
-[[package]]
-name = "webpki-roots"
-version = "0.22.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "552ceb903e957524388c4d3475725ff2c8b7960922063af6ce53c9a43da07449"
-dependencies = [
- "webpki",
-]
-
 [[package]]
 name = "which"
 version = "4.2.2"

Cargo.toml

@@ -254,7 +254,6 @@ lazy_static = { version="1.3" }
 textwrap = { version="0.15", features=["terminal_size"] }
 uucore = { version=">=0.0.11", package="uucore", path="src/uucore" }
 selinux = { version="0.2", optional = true }
-ureq = "2.4.0"
 zip = { version = "0.6.0", default_features=false, features=["deflate"] }
 # * uutils
 uu_test  = { optional=true, version="0.0.13", package="uu_test", path="src/uu/test" }

docs/.gitignore

@@ -1,3 +1,4 @@
 book
 src/utils
 src/SUMMARY.md
+tldr.zip

src/bin/uudoc.rs

@@ -8,21 +8,23 @@ use clap::Command;
 use std::collections::HashMap;
 use std::ffi::OsString;
 use std::fs::File;
-use std::io::Cursor;
 use std::io::{self, Read, Seek, Write};
 use zip::ZipArchive;
 
 include!(concat!(env!("OUT_DIR"), "/uutils_map.rs"));
 
 fn main() -> io::Result<()> {
-    println!("Downloading tldr archive");
+    let mut tldr_zip = File::open("docs/tldr.zip")
-    let mut zip_reader = ureq::get("https://tldr.sh/assets/tldr.zip")
+        .ok()
-        .call()
+        .and_then(|f| ZipArchive::new(f).ok());
-        .unwrap()
+
-        .into_reader();
+    if tldr_zip.is_none() {
-    let mut buffer = Vec::new();
+        println!("Warning: No tldr archive found, so the documentation will not include examples.");
-    zip_reader.read_to_end(&mut buffer).unwrap();
+        println!("To include examples in the documentation, download the tldr archive and put it in the docs/ folder.");
-    let mut tldr_zip = ZipArchive::new(Cursor::new(buffer)).unwrap();
+        println!();
+        println!("  curl https://tldr.sh/assets/tldr.zip -o docs/tldr.zip");
+        println!();
+    }
 
     let utils = util_map::<Box<dyn Iterator<Item = OsString>>>();
     match std::fs::create_dir("docs/src/utils/") {
@@ -109,7 +111,7 @@ struct MDWriter<'a, 'b> {
     w: Box<dyn Write>,
     command: Command<'a>,
     name: &'a str,
-    tldr_zip: &'b mut ZipArchive<Cursor<Vec<u8>>>,
+    tldr_zip: &'b mut Option<ZipArchive<File>>,
     utils_per_platform: &'b HashMap<&'b str, Vec<String>>,
 }
 
@@ -189,42 +191,43 @@ impl<'a, 'b> MDWriter<'a, 'b> {
     }
 
     fn examples(&mut self) -> io::Result<()> {
-        let content = if let Some(f) =
+        if let Some(zip) = self.tldr_zip {
-            get_zip_content(self.tldr_zip, &format!("pages/common/{}.md", self.name))
+            let content = if let Some(f) =
-        {
+                get_zip_content(zip, &format!("pages/common/{}.md", self.name))
-            f
+            {
-        } else if let Some(f) =
+                f
-            get_zip_content(self.tldr_zip, &format!("pages/linux/{}.md", self.name))
+            } else if let Some(f) = get_zip_content(zip, &format!("pages/linux/{}.md", self.name)) {
-        {
+                f
-            f
-        } else {
-            return Ok(());
-        };
-
-        writeln!(self.w, "## Examples")?;
-        writeln!(self.w)?;
-        for line in content.lines().skip_while(|l| !l.starts_with('-')) {
-            if let Some(l) = line.strip_prefix("- ") {
-                writeln!(self.w, "{}", l)?;
-            } else if line.starts_with('`') {
-                writeln!(self.w, "```shell\n{}\n```", line.trim_matches('`'))?;
-            } else if line.is_empty() {
-                writeln!(self.w)?;
             } else {
-                println!("Not sure what to do with this line:");
+                return Ok(());
-                println!("{}", line);
+            };
+
+            writeln!(self.w, "## Examples")?;
+            writeln!(self.w)?;
+            for line in content.lines().skip_while(|l| !l.starts_with('-')) {
+                if let Some(l) = line.strip_prefix("- ") {
+                    writeln!(self.w, "{}", l)?;
+                } else if line.starts_with('`') {
+                    writeln!(self.w, "```shell\n{}\n```", line.trim_matches('`'))?;
+                } else if line.is_empty() {
+                    writeln!(self.w)?;
+                } else {
+                    println!("Not sure what to do with this line:");
+                    println!("{}", line);
+                }
             }
+            writeln!(self.w)?;
+            writeln!(
+                self.w,
+                "> The examples are provided by the [tldr-pages project](https://tldr.sh) under the [CC BY 4.0 License](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md)."
+            )?;
+            writeln!(self.w, ">")?;
+            writeln!(
+                self.w,
+                "> Please note that, as uutils is a work in progress, some examples might fail."
+            )?;
         }
-        writeln!(self.w)?;
+        Ok(())
-        writeln!(
-            self.w,
-            "> The examples are provided by the [tldr-pages project](https://tldr.sh) under the [CC BY 4.0 License](https://github.com/tldr-pages/tldr/blob/main/LICENSE.md)."
-        )?;
-        writeln!(self.w, ">")?;
-        writeln!(
-            self.w,
-            "> Please note that, as uutils is a work in progress, some examples might fail."
-        )
     }
 
     fn options(&mut self) -> io::Result<()> {