Add extra CLI help string about RUST_LOG (#1053)

Improve CLI help screen
maplibre · Dec 8, 2023 · aeaa1e0 · aeaa1e0
1 parent 7ab3f5e
commit aeaa1e0
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 10 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/martin/Cargo.toml b/martin/Cargo.toml
@@ -3,7 +3,7 @@ lints.workspace = true
 [package]
 name = "martin"
 # Once the release is published with the hash, update https://github.com/maplibre/homebrew-martin
-version = "0.11.3"
+version = "0.11.4"
 authors = ["Stepan Kuzmin <[email protected]>", "Yuri Astrakhan <[email protected]>", "MapLibre contributors"]
 description = "Blazing fast and lightweight tile server with PostGIS, MBTiles, and PMTiles support"
 keywords = ["maps", "tiles", "mbtiles", "pmtiles", "postgis"]

diff --git a/martin/src/args/root.rs b/martin/src/args/root.rs
@@ -14,7 +14,11 @@ use crate::MartinError::ConfigAndConnectionsError;
 use crate::{MartinResult, OptOneMany};
 
 #[derive(Parser, Debug, PartialEq, Default)]
-#[command(about, version)]
+#[command(
+    about,
+    version,
+    after_help = "Use RUST_LOG environment variable to control logging level, e.g. RUST_LOG=debug or RUST_LOG=martin=debug. See https://docs.rs/env_logger/latest/env_logger/index.html#enabling-logging for more information."
+)]
 pub struct Args {
     #[command(flatten)]
     pub meta: MetaArgs,

diff --git a/martin/src/bin/martin-cp.rs b/martin/src/bin/martin-cp.rs
@@ -36,7 +36,8 @@ const BATCH_SIZE: usize = 1000;
 #[derive(Parser, Debug, PartialEq, Default)]
 #[command(
     about = "A tool to bulk copy tiles from any Martin-supported sources into an mbtiles file",
-    version
+    version,
+    after_help = "Use RUST_LOG environment variable to control logging level, e.g. RUST_LOG=debug or RUST_LOG=martin_cp=debug. See https://docs.rs/env_logger/latest/env_logger/index.html#enabling-logging for more information."
 )]
 pub struct CopierArgs {
     #[command(flatten)]

diff --git a/mbtiles/src/bin/mbtiles.rs b/mbtiles/src/bin/mbtiles.rs
@@ -8,7 +8,8 @@ use mbtiles::{apply_patch, AggHashType, IntegrityCheckType, MbtResult, Mbtiles,
 #[command(
     version,
     name = "mbtiles",
-    about = "A utility to work with .mbtiles file content"
+    about = "A utility to work with .mbtiles file content",
+    after_help = "Use RUST_LOG environment variable to control logging level, e.g. RUST_LOG=debug or RUST_LOG=mbtiles=debug. See https://docs.rs/env_logger/latest/env_logger/index.html#enabling-logging for more information."
 )]
 pub struct Args {
     /// Display detailed information

diff --git a/tests/expected/martin-cp/flat-with-hash_metadata.txt b/tests/expected/martin-cp/flat-with-hash_metadata.txt
@@ -9,6 +9,6 @@ tilejson:
   description: public.function_zxy_query_test
   name: function_zxy_query_test
   format: mvt
-  generator: martin-cp v0.11.3
+  generator: martin-cp v0.11.4
 agg_tiles_hash: 9B931A386D6075D1DA55323BD4DBEDAE
 
diff --git a/tests/expected/martin-cp/flat_metadata.txt b/tests/expected/martin-cp/flat_metadata.txt
@@ -18,6 +18,6 @@ tilejson:
   name: table_source
   foo: '{"bar":"foo"}'
   format: mvt
-  generator: martin-cp v0.11.3
+  generator: martin-cp v0.11.4
 agg_tiles_hash: EF19FCBCE73ADE1C85E856E6BBA9B4C7
 
diff --git a/tests/expected/martin-cp/normalized_metadata.txt b/tests/expected/martin-cp/normalized_metadata.txt
@@ -35,6 +35,6 @@ tilejson:
     </div>{{/__teaser__}}{{#__full__}}{{/__full__}}
   version: 1.0.0
   format: png
-  generator: martin-cp v0.11.3
+  generator: martin-cp v0.11.4
 agg_tiles_hash: A85C80BA1CE047E2D93DAC25C5179775