Add docs and --dry-run

Author: cruessler

gix-diff/src/blob/unified_diff/impls.rs

@@ -260,7 +260,7 @@ where
 }
 
 impl DiffLineKind {
-    /// TODO: Document.
+    /// Returns a one-character representation for use in unified diffs.
     pub const fn to_prefix(self) -> char {
         match self {
             DiffLineKind::Context => ' ',

tests/it/src/args.rs

@@ -123,9 +123,19 @@ pub enum Subcommands {
         #[clap(value_parser = AsPathSpec)]
         patterns: Vec<gix::pathspec::Pattern>,
     },
-    /// TODO: add description.
+    /// Take a slider file generated with the help of [diff-slider-tools] and turn it into a series
+    /// of baseline diffs to be used in [slider-rs].
+    ///
+    /// See [make-diff-for-sliders-repo] for details.
+    ///
+    /// [diff-slider-tools]: https://github.com/mhagger/diff-slider-tools
+    /// [slider-rs]: gix-diff/tests/diff/blob/slider.rs
+    /// [make-diff-for-sliders-repo]: gix-diff/tests/fixtures/make_diff_for_sliders_repo.sh
     CreateDiffCases {
-        /// TODO: add description.
+        /// Don't really copy anything.
+        #[clap(long, short = 'n')]
+        dry_run: bool,
+        /// The `.sliders` file that contains a list of sliders.
         #[clap(long)]
         sliders_file: PathBuf,
         /// The git root to extract the diff-related parts from.
@@ -134,7 +144,7 @@ pub enum Subcommands {
         /// The directory into which to copy the files.
         #[clap(long)]
         destination_dir: PathBuf,
-        /// TODO: add description.
+        /// The number of sliders to generate test cases for.
         #[clap(long, default_value_t = 10)]
         count: usize,
         /// The directory to place assets in.

tests/it/src/commands/create_diff_cases.rs

@@ -11,15 +11,13 @@ pub(super) mod function {
     };
 
     pub fn create_diff_cases(
+        dry_run: bool,
         sliders_file: PathBuf,
         worktree_dir: &Path,
         destination_dir: PathBuf,
         count: usize,
         asset_dir: Option<BString>,
     ) -> anyhow::Result<()> {
-        // TODO: turn into parameter.
-        let dry_run = false;
-
         let prefix = if dry_run { "WOULD" } else { "Will" };
         let sliders = std::fs::read_to_string(&sliders_file)?;
 

tests/it/src/main.rs

@@ -47,12 +47,13 @@ fn main() -> anyhow::Result<()> {
             patterns,
         } => commands::copy_royal(dry_run, &worktree_root, destination_dir, patterns),
         Subcommands::CreateDiffCases {
+            dry_run,
             sliders_file,
             worktree_dir,
             destination_dir,
             count,
             asset_dir,
-        } => commands::create_diff_cases(sliders_file, &worktree_dir, destination_dir, count, asset_dir),
+        } => commands::create_diff_cases(dry_run, sliders_file, &worktree_dir, destination_dir, count, asset_dir),
         Subcommands::CheckMode {} => commands::check_mode(),
         Subcommands::Env {} => commands::env(),
     }