git 5.0.0.beta.2 → 5.0.0.beta.4

data/lib/git/commands/add.rb

@@ -9,6 +9,12 @@ module Git
     # This command updates the index using the current content found in the working tree,
     # to prepare the content staged for the next commit.
     #
+    # @example Basic usage
+    #   add = Git::Commands::Add.new(execution_context)
+    #   add.call('path/to/file')
+    #   add.call('file1.rb', 'file2.rb')
+    #   add.call(all: true)
+    #
     # @note `arguments` block audited against https://git-scm.com/docs/git-add/2.53.0
     #
     # @see https://git-scm.com/docs/git-add git-add
@@ -17,12 +23,6 @@ module Git
     #
     # @api private
     #
-    # @example Basic usage
-    #   add = Git::Commands::Add.new(execution_context)
-    #   add.call('path/to/file')
-    #   add.call('file1.rb', 'file2.rb')
-    #   add.call(all: true)
-    #
     class Add < Git::Commands::Base
       arguments do
         literal 'add'
@@ -46,86 +46,94 @@ module Git
         operand :pathspec, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @overload call(*pathspec, **options)
       #
-      #   @overload call(*pathspec, **options)
+      #   Execute the `git add` command
       #
-      #     Execute the `git add` command
+      #   @param pathspec [Array<String>] files to be added to the repository
+      #     (relative to the worktree root)
       #
-      #     @param pathspec [Array<String>] files to be added to the repository
-      #       (relative to the worktree root)
+      #   @param options [Hash] command options
       #
-      #     @param options [Hash] command options
+      #   @option options [Boolean, nil] :verbose (nil) be verbose
       #
-      #     @option options [Boolean, nil] :verbose (nil) be verbose
+      #     Alias: :v
       #
-      #       Alias: :v
+      #   @option options [Boolean, nil] :dry_run (nil) don't actually add files;
+      #     show what would be added
       #
-      #     @option options [Boolean, nil] :dry_run (nil) don't actually add files; show what would be added
+      #     Alias: :n
       #
-      #       Alias: :n
+      #   @option options [Boolean, nil] :force (nil) allow adding otherwise ignored
+      #     files
       #
-      #     @option options [Boolean, nil] :force (nil) allow adding otherwise ignored files
+      #     Alias: :f
       #
-      #       Alias: :f
+      #   @option options [Boolean, nil] :all (nil) add, modify, and remove index
+      #     entries to match the worktree (--all)
       #
-      #     @option options [Boolean, nil] :all (nil) add, modify, and remove index entries to
-      #       match the worktree (--all)
+      #     Alias: :A
       #
-      #       Alias: :A
+      #   @option options [Boolean, nil] :no_all (nil) add and modify index entries
+      #     without staging removals (--no-all)
       #
-      #     @option options [Boolean, nil] :no_all (nil) add and modify index entries without staging
-      #       removals (--no-all)
+      #   @option options [Boolean, nil] :ignore_removal (nil) add and modify files;
+      #     ignore removals (--ignore-removal)
       #
-      #     @option options [Boolean, nil] :ignore_removal (nil) add and modify files; ignore removals
-      #       (--ignore-removal)
+      #   @option options [Boolean, nil] :no_ignore_removal (nil) include file removals
+      #     (--no-ignore-removal)
       #
-      #     @option options [Boolean, nil] :no_ignore_removal (nil) include file removals (--no-ignore-removal)
+      #   @option options [Boolean, nil] :update (nil) update tracked files only; does
+      #     not add new files
       #
-      #     @option options [Boolean, nil] :update (nil) update tracked files only; does not add new files
+      #     Alias: :u
       #
-      #       Alias: :u
+      #   @option options [Boolean, nil] :sparse (nil) allow updating index entries
+      #     outside the sparse-checkout cone
       #
-      #     @option options [Boolean, nil] :sparse (nil) allow updating index entries outside the
-      #       sparse-checkout cone
+      #   @option options [Boolean, nil] :intent_to_add (nil) record that the path
+      #     will be added later, placing an empty entry in the index
       #
-      #     @option options [Boolean, nil] :intent_to_add (nil) record that the path will be added later,
-      #       placing an empty entry in the index
+      #     Alias: :N
       #
-      #       Alias: :N
+      #   @option options [Boolean, nil] :refresh (nil) refresh stat() information in
+      #     the index without adding files
       #
-      #     @option options [Boolean, nil] :refresh (nil) refresh stat() information in the index without
-      #       adding files
+      #   @option options [Boolean, nil] :ignore_errors (nil) continue adding other
+      #     files if some files cannot be added due to indexing errors
       #
-      #     @option options [Boolean, nil] :ignore_errors (nil) continue adding other files if some files
-      #       cannot be added due to indexing errors
+      #   @option options [Boolean, nil] :ignore_missing (nil) check whether any given
+      #     files would be ignored
       #
-      #     @option options [Boolean, nil] :ignore_missing (nil) check whether any given files would be
-      #       ignored
+      #   @option options [Boolean, nil] :renormalize (nil) apply the "clean" process
+      #     freshly to all tracked files to forcibly re-add them with correct line
+      #     endings
       #
-      #     @option options [Boolean, nil] :renormalize (nil) apply the "clean" process freshly to all tracked
-      #       files to forcibly re-add them with correct line endings
+      #   @option options [Boolean, nil] :no_warn_embedded_repo (nil) suppress warning
+      #     when adding an embedded repository without using `git submodule add`
       #
-      #     @option options [Boolean, nil] :no_warn_embedded_repo (nil) suppress warning when adding an
-      #       embedded repository without using `git submodule add`
+      #   @option options [String] :chmod (nil) override the executable bit of added
+      #     files in the index
       #
-      #     @option options [String] :chmod (nil) override the executable bit of added files in the index
+      #     Value must be `'+x'` or `'-x'`
       #
-      #       Value must be `'+x'` or `'-x'`
+      #   @option options [String] :pathspec_from_file (nil) read pathspec from the
+      #     given file (use `'-'` for stdin)
       #
-      #     @option options [String] :pathspec_from_file (nil) read pathspec from the given file
-      #       (use `'-'` for stdin)
+      #   @option options [Boolean, nil] :pathspec_file_nul (nil) separate pathspec
+      #     elements with NUL when reading from a file
       #
-      #     @option options [Boolean, nil] :pathspec_file_nul (nil) separate pathspec elements with NUL
-      #       when reading from a file
+      #   @return [Git::CommandLine::Result] the result of calling `git add`
       #
-      #     @return [Git::CommandLineResult] the result of calling `git add`
+      #   @raise [ArgumentError] if unsupported options are provided
       #
-      #     @raise [ArgumentError] if unsupported options are provided
+      #   @raise [Git::FailedError] if git exits with a non-zero exit status
       #
-      #     @raise [Git::FailedError] if git exits with a non-zero exit status
+      #   @api public
       #
-      #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/am/abort.rb

@@ -28,13 +28,13 @@ module Git
           literal '--abort'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Abort the in-progress am session and restore the branch
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am --abort`
+        #     @return [Git::CommandLine::Result] the result of calling `git am --abort`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/am/apply.rb

@@ -84,168 +84,179 @@ module Git
           operand :mbox, repeatable: true
         end
 
-        # @!method call(*, **)
+        # @overload call(*mbox, **options)
         #
-        #   @overload call(*mbox, **options)
+        #   Apply patches from one or more mailbox files to the current branch
         #
-        #     Apply patches from one or more mailbox files to the current branch.
+        #   @param mbox [Array<String>] zero or more mailbox file paths or Maildir
+        #     directories
         #
-        #     @param mbox [Array<String>] zero or more mailbox file paths or Maildir
-        #       directories
+        #     If omitted, reads from standard input.
         #
-        #       If omitted, reads from standard input.
+        #   @param options [Hash] command options
         #
-        #     @param options [Hash] command options
+        #   @option options [Boolean, nil] :signoff (nil) add Signed-off-by trailer
         #
-        #     @option options [Boolean, nil] :signoff (nil) add Signed-off-by trailer
+        #     Alias: `:s`
         #
-        #       Alias: `:s`
+        #   @option options [Boolean, nil] :keep (nil) preserve the Subject line
+        #     in commit messages (`--keep`)
         #
-        #     @option options [Boolean, nil] :keep (nil) pass -k flag to git-mailinfo,
-        #       preserving the Subject line intact
+        #     Alias: `:k`
         #
-        #       Alias: `:k`
+        #   @option options [Boolean, nil] :keep_non_patch (nil) retain non-patch
+        #     parts of the message body (`--keep-non-patch`)
         #
-        #     @option options [Boolean, nil] :keep_non_patch (nil) pass -b flag to
-        #       git-mailinfo
+        #   @option options [Boolean, nil] :keep_cr (nil) retain CR at end of
+        #     lines (`--keep-cr`)
         #
-        #     @option options [Boolean, nil] :keep_cr (nil) retain CR at end of lines (`--keep-cr`)
+        #   @option options [Boolean, nil] :no_keep_cr (nil) strip CR at end of
+        #     lines (`--no-keep-cr`)
         #
-        #     @option options [Boolean, nil] :no_keep_cr (nil) strip CR at end of lines (`--no-keep-cr`)
+        #   @option options [Boolean, nil] :scissors (nil) remove everything in the
+        #     body before a scissors line (`--scissors`)
         #
-        #     @option options [Boolean, nil] :scissors (nil) remove everything in the
-        #       body before a scissors line (`--scissors`)
+        #     Alias: `:c`
         #
-        #       Alias: `:c`
+        #   @option options [Boolean, nil] :no_scissors (nil) disable scissors
+        #     mode (`--no-scissors`)
         #
-        #     @option options [Boolean, nil] :no_scissors (nil) disable scissors mode (`--no-scissors`)
+        #   @option options [String] :quoted_cr (nil) how to handle CR in quoted
+        #     text passed to git-mailinfo
         #
-        #     @option options [String] :quoted_cr (nil) how to handle CR in quoted
-        #       text passed to git-mailinfo
+        #     Valid actions: `'nowarn'`, `'warn'`, `'error'`.
         #
-        #       Valid actions: `'nowarn'`, `'warn'`, `'error'`.
+        #   @option options [String] :empty (nil) how to handle an e-mail message
+        #     lacking a patch
         #
-        #     @option options [String] :empty (nil) how to handle an e-mail message
-        #       lacking a patch
+        #     Valid values: `'stop'` (fail, default), `'drop'` (skip the message),
+        #     `'keep'` (create an empty commit).
         #
-        #       Valid values: `'stop'` (fail, default), `'drop'` (skip the message),
-        #       `'keep'` (create an empty commit).
+        #   @option options [Boolean, nil] :message_id (nil) add the Message-ID
+        #     header to commit messages (`--message-id`)
         #
-        #     @option options [Boolean, nil] :message_id (nil) pass -m flag to
-        #       git-mailinfo, adding the Message-ID header to the commit message (`--message-id`)
+        #     Alias: `:m`
         #
-        #       Alias: `:m`
+        #   @option options [Boolean, nil] :no_message_id (nil) do not add the
+        #     Message-ID header (`--no-message-id`)
         #
-        #     @option options [Boolean, nil] :no_message_id (nil) do not add the Message-ID header (`--no-message-id`)
+        #   @option options [Boolean, nil] :quiet (nil) be quiet; only print error
+        #     messages
         #
-        #     @option options [Boolean, nil] :quiet (nil) be quiet; only print error
-        #       messages
+        #     Alias: `:q`
         #
-        #       Alias: `:q`
+        #   @option options [Boolean, nil] :utf8 (nil) re-code the commit log message
+        #     in UTF-8 (`--utf8`)
         #
-        #     @option options [Boolean, nil] :utf8 (nil) re-code the commit log message
-        #       in UTF-8 (`--utf8`)
+        #     Alias: `:u`
         #
-        #       Alias: `:u`
+        #   @option options [Boolean, nil] :no_utf8 (nil) do not re-code the
+        #     commit log message (`--no-utf8`)
         #
-        #     @option options [Boolean, nil] :no_utf8 (nil) do not re-code the commit log message (`--no-utf8`)
+        #   @option options [Boolean, nil] :three_way (nil) attempt 3-way merge when
+        #     context does not match (`--3way`)
         #
-        #     @option options [Boolean, nil] :three_way (nil) attempt 3-way merge when
-        #       context does not match (`--3way`)
+        #   @option options [Boolean, nil] :no_three_way (nil) disable 3-way
+        #     merge fallback (`--no-3way`)
         #
-        #     @option options [Boolean, nil] :no_three_way (nil) disable 3-way merge fallback (`--no-3way`)
+        #   @option options [Boolean, nil] :rerere_autoupdate (nil) allow rerere to
+        #     update the index with auto-resolved conflicts (`--rerere-autoupdate`)
         #
-        #     @option options [Boolean, nil] :rerere_autoupdate (nil) allow rerere to
-        #       update the index with auto-resolved conflicts (`--rerere-autoupdate`)
+        #   @option options [Boolean, nil] :no_rerere_autoupdate (nil) prevent rerere from
+        #     auto-updating the index (`--no-rerere-autoupdate`)
         #
-        #     @option options [Boolean, nil] :no_rerere_autoupdate (nil) prevent rerere from
-        #       auto-updating the index (`--no-rerere-autoupdate`)
+        #   @option options [Boolean, nil] :ignore_space_change (nil) ignore whitespace
+        #     changes when applying (passed to git-apply)
         #
-        #     @option options [Boolean, nil] :ignore_space_change (nil) ignore whitespace
-        #       changes when applying (passed to git-apply)
+        #   @option options [Boolean, nil] :ignore_whitespace (nil) ignore whitespace
+        #     when applying (passed to git-apply)
         #
-        #     @option options [Boolean, nil] :ignore_whitespace (nil) ignore whitespace
-        #       when applying (passed to git-apply)
+        #   @option options [String] :whitespace (nil) whitespace error handling
+        #     (e.g., `'nowarn'`, `'warn'`, `'fix'`, `'error'`)
         #
-        #     @option options [String] :whitespace (nil) whitespace error handling
-        #       (e.g., `'nowarn'`, `'warn'`, `'fix'`, `'error'`)
+        #     Passed to git-apply.
         #
-        #       Passed to git-apply.
+        #   @option options [Integer, String] :C (nil) ensure at least `<n>` lines of
+        #     surrounding context match when applying (`-C<n>`)
         #
-        #     @option options [Integer] :C (nil) ensure at least `<n>` lines of
-        #       surrounding context match when applying (`-C<n>`)
+        #     Passed to git-apply.
         #
-        #       Passed to git-apply.
+        #   @option options [Integer, String] :p (nil) strip `<n>` leading path
+        #     components
+        #     from file names (`-p<n>`)
         #
-        #     @option options [Integer] :p (nil) strip `<n>` leading path components
-        #       from file names (`-p<n>`)
+        #     Passed to git-apply.
         #
-        #       Passed to git-apply.
+        #   @option options [String] :directory (nil) prepend `<dir>` to all
+        #     filenames
         #
-        #     @option options [String] :directory (nil) prepend `<dir>` to all
-        #       filenames
+        #     Passed to git-apply.
         #
-        #       Passed to git-apply.
+        #   @option options [String, Array<String>] :exclude (nil) skip files
+        #     matching the given path pattern
         #
-        #     @option options [Array<String>] :exclude (nil) skip files matching the
-        #       given path pattern
+        #     May be repeated. Passed to git-apply.
         #
-        #       May be repeated. Passed to git-apply.
+        #   @option options [String, Array<String>] :include (nil) apply only to
+        #     files matching the given path pattern
         #
-        #     @option options [Array<String>] :include (nil) apply only to files
-        #       matching the given path pattern
+        #     May be repeated. Passed to git-apply.
         #
-        #       May be repeated. Passed to git-apply.
+        #   @option options [Boolean, nil] :reject (nil) leave rejected hunks in
+        #     `*.rej` files instead of aborting
         #
-        #     @option options [Boolean, nil] :reject (nil) leave rejected hunks in
-        #       `*.rej` files instead of aborting
+        #     Passed to git-apply.
         #
-        #       Passed to git-apply.
+        #   @option options [String] :patch_format (nil) override patch format
+        #     detection
         #
-        #     @option options [String] :patch_format (nil) override patch format
-        #       detection
+        #     Valid formats: `'mbox'`, `'mboxrd'`, `'stgit'`, `'stgit-series'`,
+        #     `'hg'`.
         #
-        #       Valid formats: `'mbox'`, `'mboxrd'`, `'stgit'`, `'stgit-series'`,
-        #       `'hg'`.
+        #   @option options [Boolean, nil] :interactive (nil) run interactively,
+        #     prompting before each patch is applied
         #
-        #     @option options [Boolean, nil] :interactive (nil) run interactively,
-        #       prompting before each patch is applied
+        #     Alias: `:i`
         #
-        #       Alias: `:i`
+        #   @option options [Boolean, nil] :verify (nil) run pre-applypatch and
+        #     applypatch-msg hooks (`--verify`)
         #
-        #     @option options [Boolean, nil] :verify (nil) run pre-applypatch and
-        #       applypatch-msg hooks (`--verify`)
+        #     Hooks are run by default when this option is omitted.
         #
-        #       Hooks are run by default when this option is omitted.
+        #   @option options [Boolean, nil] :no_verify (nil) bypass pre-applypatch and
+        #     applypatch-msg hooks (`--no-verify`)
         #
-        #     @option options [Boolean, nil] :no_verify (nil) bypass pre-applypatch and
-        #       applypatch-msg hooks (`--no-verify`)
+        #   @option options [Boolean, nil] :committer_date_is_author_date (nil) use the
+        #     author date as the committer date
         #
-        #     @option options [Boolean, nil] :committer_date_is_author_date (nil) use the
-        #       author date as the committer date
+        #   @option options [Boolean, nil] :ignore_date (nil) use the committer date as
+        #     the author date
         #
-        #     @option options [Boolean, nil] :ignore_date (nil) use the committer date as
-        #       the author date
+        #   @option options [Boolean, String, nil] :gpg_sign (nil) sign commits using
+        #     GPG (`--gpg-sign`)
         #
-        #     @option options [Boolean, String, nil] :gpg_sign (nil) sign commits using
-        #       GPG (`--gpg-sign`)
+        #     Pass a key-ID string to select the signing key; pass `true` to use
+        #     the committer identity. Alias: `:S`
         #
-        #       Pass a key-ID string to select the signing key; pass `true` to use
-        #       the committer identity. Alias: `:S`
+        #   @option options [Boolean, nil] :no_gpg_sign (nil) countermand commit.gpgSign
+        #     configuration (`--no-gpg-sign`)
         #
-        #     @option options [Boolean, nil] :no_gpg_sign (nil) countermand commit.gpgSign
-        #       configuration (`--no-gpg-sign`)
+        #   @option options [String] :chdir (nil) change to this directory before
+        #     running git
         #
-        #     @option options [String] :chdir (nil) change to this directory before
-        #       running git
+        #     Not passed to the git CLI.
         #
-        #       Not passed to the git CLI.
+        #   @return [Git::CommandLine::Result] the result of calling `git am`
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am`
+        #   @raise [ArgumentError] if unsupported options are provided
         #
-        #     @raise [ArgumentError] if unsupported options are provided
+        #   @raise [Git::FailedError] if git exits with a non-zero exit status
         #
-        #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #   @api public
+        #
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/am/continue.rb

@@ -28,13 +28,13 @@ module Git
           literal '--continue'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Resume applying patches after conflicts have been resolved
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am --continue`
+        #     @return [Git::CommandLine::Result] the result of calling `git am --continue`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/am/quit.rb

@@ -28,13 +28,13 @@ module Git
           literal '--quit'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Abort the am session but keep the current HEAD position
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am --quit`
+        #     @return [Git::CommandLine::Result] the result of calling `git am --quit`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/am/retry.rb

@@ -32,13 +32,15 @@ module Git
         # git am --retry was introduced in git 2.46.0
         requires_git_version '2.46.0'
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Retry applying the most-recently-failed patch
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am --retry`
+        #     @return [Git::CommandLine::Result] the result of calling `git am --retry`
+        #
+        #     @raise [Git::VersionError] if git version is below 2.46.0
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/am/show_current_patch.rb

@@ -41,7 +41,7 @@ module Git
         #
         #   @param options [Hash] command options
         #
-        #   @return [Git::CommandLineResult] the result of calling
+        #   @return [Git::CommandLine::Result] the result of calling
         #     `git am --show-current-patch`
         #
         #   @raise [ArgumentError] if `show_current_patch` is `false` or `nil`

data/lib/git/commands/am/skip.rb

@@ -27,13 +27,13 @@ module Git
           literal '--skip'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Skip the current patch and continue with remaining patches
         #
-        #     @return [Git::CommandLineResult] the result of calling `git am --skip`
+        #     @return [Git::CommandLine::Result] the result of calling `git am --skip`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/am.rb

@@ -23,10 +23,10 @@ module Git
     # - {Am::ShowCurrentPatch} — show the patch being applied (`--show-current-patch`)
     # - {Am::Skip} — skip the current patch (`--skip`)
     #
-    # @api private
-    #
     # @see https://git-scm.com/docs/git-am git-am documentation
     #
+    # @api private
+    #
     module Am
     end
   end

data/lib/git/commands/apply.rb

@@ -90,7 +90,12 @@ module Git
         operand :patch, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :stat (nil) command option key; see overload
+      #     docs for the full option list
       #
       #   @overload call(*patch, **options)
       #
@@ -225,7 +230,7 @@ module Git
       #     @option options [String] :chdir (nil) change to this directory before
       #       running git; not passed to the git CLI
       #
-      #     @return [Git::CommandLineResult] the result of calling `git apply`
+      #     @return [Git::CommandLine::Result] the result of calling `git apply`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #

data/lib/git/commands/archive/list_formats.rb

@@ -31,13 +31,13 @@ module Git
           literal '--list'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
-        #   @overload call
+        #   @overload call()
         #
         #     Execute `git archive --list` to show available formats.
         #
-        #     @return [Git::CommandLineResult] the result of calling `git archive --list`
+        #     @return [Git::CommandLine::Result] the result of calling `git archive --list`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
       end

data/lib/git/commands/archive.rb

@@ -55,7 +55,12 @@ module Git
         operand :path, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [String] :format (nil) command option key; see overload docs
+      #     for the full option list
       #
       #   @overload call(tree_ish = nil, *path, **options)
       #
@@ -111,7 +116,7 @@ module Git
       #     @option options [IO, #write] :out (nil) stream archive output to this IO object
       #       instead of capturing it; the result's `.stdout` will be `''`
       #
-      #     @return [Git::CommandLineResult] the result of calling `git archive`
+      #     @return [Git::CommandLine::Result] the result of calling `git archive`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #