feat: gix status -s/--statistics to obtain additional information on what happened.

This is useful for understanding performance characteristics in detail.

Author: Byron

gitoxide-core/src/repository/status.rs

@@ -20,6 +20,7 @@ pub struct Options {
     pub format: OutputFormat,
     pub submodules: Submodules,
     pub thread_limit: Option<usize>,
+    pub statistics: bool,
 }
 
 pub fn show(
@@ -33,12 +34,13 @@ pub fn show(
         // TODO: implement this
         submodules: _,
         thread_limit,
+        statistics,
     }: Options,
 ) -> anyhow::Result<()> {
     if format != OutputFormat::Human {
         bail!("Only human format is supported right now");
     }
-    let mut index = repo.index()?;
+    let mut index = repo.index_or_empty()?;
     let index = gix::threading::make_mut(&mut index);
     let pathspec = repo.pathspec(
         pathspecs,
@@ -65,7 +67,7 @@ pub fn show(
             _ => unreachable!("state must be attributes stack only"),
         },
     };
-    gix_status::index_as_worktree(
+    let outcome = gix_status::index_as_worktree(
         index,
         repo.work_dir()
             .context("This operation cannot be run on a bare repository")?,
@@ -86,6 +88,10 @@ pub fn show(
         options,
     )?;
 
+    if statistics {
+        writeln!(err, "{outcome:#?}").ok();
+    }
+
     writeln!(err, "\nhead -> index and untracked files aren't implemented yet")?;
     progress.show_throughput(start);
     Ok(())
@@ -158,6 +164,15 @@ fn change_to_char(change: &Change<()>) -> u8 {
     match change {
         Change::Removed => b'D',
         Change::Type => b'T',
-        Change::SubmoduleModification(_) | Change::Modification { .. } => b'M',
+        Change::SubmoduleModification(_) => b'M',
+        Change::Modification {
+            executable_bit_changed, ..
+        } => {
+            if *executable_bit_changed {
+                b'X'
+            } else {
+                b'M'
+            }
+        }
     }
 }

src/plumbing/main.rs

@@ -133,7 +133,11 @@ pub fn main() -> Result<()> {
     })?;
 
     match cmd {
-        Subcommands::Status(crate::plumbing::options::status::Platform { submodules, pathspec }) => prepare_and_run(
+        Subcommands::Status(crate::plumbing::options::status::Platform {
+            statistics,
+            submodules,
+            pathspec,
+        }) => prepare_and_run(
             "status",
             trace,
             auto_verbose,
@@ -150,6 +154,7 @@ pub fn main() -> Result<()> {
                     progress,
                     core::repository::status::Options {
                         format,
+                        statistics,
                         thread_limit: thread_limit.or(cfg!(target_os = "macos").then_some(3)), // TODO: make this a configurable when in `gix`, this seems to be optimal on MacOS, linux scales though!
                         submodules: match submodules {
                             Submodules::All => core::repository::status::Submodules::All,

src/plumbing/options/mod.rs

@@ -205,6 +205,9 @@ pub mod status {
         /// Define how to display submodule status.
         #[clap(long, default_value = "all")]
         pub submodules: Submodules,
+        /// Print additional statistics to help understanding performance.
+        #[clap(long, short = 's')]
+        pub statistics: bool,
         /// The git path specifications to list attributes for, or unset to read from stdin one per line.
         #[clap(value_parser = CheckPathSpec)]
         pub pathspec: Vec<BString>,