From 6e1fed9c5283247bbf3c64427a758689f9cc97cd Mon Sep 17 00:00:00 2001 From: phiresky Date: Tue, 21 Feb 2023 11:49:43 +0100 Subject: [PATCH] doc comment --- Cargo.lock | 8 ++++---- src/config.rs | 7 ++++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 8766c3c..0df8f0d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1575,9 +1575,9 @@ dependencies = [ [[package]] name = "slab" -version = "0.4.7" +version = "0.4.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4614a76b2a8be0058caa9dbbaf66d988527d86d003c11a94fbd335d7661edcef" +checksum = "6528351c9bc8ab22353f9d776db39a20288e8d6c37ef8cfe3317cf875eecfc2d" dependencies = [ "autocfg", ] @@ -1786,9 +1786,9 @@ dependencies = [ [[package]] name = "tokio-stream" -version = "0.1.11" +version = "0.1.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d660770404473ccd7bc9f8b28494a811bc18542b915c0855c51e8f419d5223ce" +checksum = "8fb52b74f05dbf495a8fba459fdc331812b96aa086d9eb78101fa0d4569c3313" dependencies = [ "futures-core", "pin-project-lite 0.2.9", diff --git a/src/config.rs b/src/config.rs index df6979f..40ef3f0 100644 --- a/src/config.rs +++ b/src/config.rs @@ -108,6 +108,7 @@ impl FromStr for CacheMaxBlobLen { rename_all = "kebab-case", about = env!("CARGO_PKG_DESCRIPTION"), author = env!("CARGO_PKG_HOMEPAGE"), + long_about="rga: ripgrep, but also search in PDFs, E-Books, Office documents, zip, tar.gz, etc.", // TODO: long_about does not seem to work to only show this on short help after_help = "-h shows a concise overview, --help shows more detail and advanced options.\n\nAll other options not shown here are passed directly to rg, especially [PATTERN] and [PATH ...]", usage = "rga [RGA OPTIONS] [RG OPTIONS] PATTERN [PATH ...]" @@ -197,9 +198,9 @@ pub struct CacheConfig { /// Disable caching of results /// /// By default, rga caches the extracted text, if it is small enough, - /// to a database in ~/.cache/rga on Linux, - /// ~/Library/Caches/rga on macOS, - /// or C:\Users\username\AppData\Local\rga on Windows. + /// to a database in ${XDG_CACHE_DIR-~/.cache}/ripgrep-all on Linux, + /// ~/Library/Caches/ripgrep-all on macOS, + /// or C:\Users\username\AppData\Local\ripgrep-all on Windows. /// This way, repeated searches on the same set of files will be much faster. /// If you pass this flag, all caching will be disabled. #[serde(default, skip_serializing_if = "is_default")]