From 2704ff47859ab635cd8a8f8abd8ab25811bc2809 Mon Sep 17 00:00:00 2001 From: Brad Larsen Date: Tue, 24 Oct 2023 18:06:04 -0400 Subject: [PATCH] Refine usage message and changelog --- CHANGELOG.md | 3 ++- crates/noseyparker-cli/src/args.rs | 9 ++++++--- .../snapshots/test_noseyparker__help__help_scan-2.snap | 9 ++++++--- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 37703636c..0f8e13b2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), When specified as `matching`, a copy of each encountered blob that has matches will be saved to the datastore's `blobs` directory. When specified as `all`, a copy of _each_ encountered blob will be saved. The default value is `none`. - Saved copies of blobs are used for no additional purpose at present within Nosey Parker. + This mechanism exists to aid in ad-hoc downstream investigation. + Copied blobs are not used elsewhere in Nosey Parker at this point. - A new advanced global command-line parameter has been exposed: diff --git a/crates/noseyparker-cli/src/args.rs b/crates/noseyparker-cli/src/args.rs index 64d7a0f66..2f3a7b836 100644 --- a/crates/noseyparker-cli/src/args.rs +++ b/crates/noseyparker-cli/src/args.rs @@ -448,6 +448,9 @@ pub struct ScanArgs { /// If this option is enabled, corresponding blobs will be written to the `blobs` directory within the datastore. /// The format of that directory is similar to Git's "loose" object format: /// the first 2 characters of the hex-encoded blob ID name a subdirectory, and the remaining characters are used as the filename. + /// + /// This mechanism exists to aid in ad-hoc downstream investigation. + /// Copied blobs are not used elsewhere in Nosey Parker at this point. #[arg( long, default_value_t=CopyBlobsMode::None, @@ -517,13 +520,13 @@ pub enum BlobMetadataMode { #[derive(Copy, Clone, Debug, Display, PartialEq, Eq, PartialOrd, Ord, ValueEnum)] #[strum(serialize_all="kebab-case")] pub enum CopyBlobsMode { - /// Save all encountered blobs + /// Copy all encountered blobs All, - /// Save only blobs with matches + /// Copy only blobs with matches Matching, - /// Save no blobs + /// Copy no blobs None, } diff --git a/crates/noseyparker-cli/tests/help/snapshots/test_noseyparker__help__help_scan-2.snap b/crates/noseyparker-cli/tests/help/snapshots/test_noseyparker__help__help_scan-2.snap index e27253e7b..cf3a85f94 100644 --- a/crates/noseyparker-cli/tests/help/snapshots/test_noseyparker__help__help_scan-2.snap +++ b/crates/noseyparker-cli/tests/help/snapshots/test_noseyparker__help__help_scan-2.snap @@ -177,12 +177,15 @@ Data Collection Options: format: the first 2 characters of the hex-encoded blob ID name a subdirectory, and the remaining characters are used as the filename. + This mechanism exists to aid in ad-hoc downstream investigation. Copied blobs are not used + elsewhere in Nosey Parker at this point. + [default: none] Possible values: - - all: Save all encountered blobs - - matching: Save only blobs with matches - - none: Save no blobs + - all: Copy all encountered blobs + - matching: Copy only blobs with matches + - none: Copy no blobs Global Options: -v, --verbose...