Skip to content

Commit

Permalink
Refine usage message and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
bradlarsen committed Oct 24, 2023
1 parent 4095cec commit 2704ff4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
9 changes: 6 additions & 3 deletions crates/noseyparker-cli/src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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...
Expand Down

0 comments on commit 2704ff4

Please sign in to comment.