git 5.0.0.beta.3 → 5.0.0.beta.4

data/lib/git/commands/rev_parse.rb

@@ -101,197 +101,204 @@ module Git
         operand :args, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @overload call(*args, **options)
       #
-      #   @overload call(*args, **options)
+      #   Execute the `git rev-parse` command
       #
-      #     Execute the `git rev-parse` command
+      #   @param args [Array<String>] zero or more revision specifiers,
+      #     object names, or file paths to parse. Include `'--'` to
+      #     separate verified arguments from those echoed back without
+      #     verification, e.g. `call('HEAD', '--', 'file.txt')`
       #
-      #     @param args [Array<String>] zero or more revision specifiers,
-      #       object names, or file paths to parse. Include `'--'` to
-      #       separate verified arguments from those echoed back without
-      #       verification, e.g. `call('HEAD', '--', 'file.txt')`.
+      #   @param options [Hash] command options
       #
-      #     @param options [Hash] command options
+      #   @option options [Boolean, nil] :revs_only (nil) do not output flags
+      #     and parameters not meant for `git rev-list`
       #
-      #     @option options [Boolean, nil] :revs_only (nil) do not output flags
-      #       and parameters not meant for `git rev-list`
+      #   @option options [Boolean, nil] :no_revs (nil) do not output flags and
+      #     parameters meant for `git rev-list`
       #
-      #     @option options [Boolean, nil] :no_revs (nil) do not output flags and
-      #       parameters meant for `git rev-list`
+      #   @option options [Boolean, nil] :flags (nil) do not output non-flag
+      #     parameters (`--flags`)
       #
-      #     @option options [Boolean, nil] :flags (nil) do not output non-flag
-      #       parameters (`--flags`)
+      #   @option options [Boolean, nil] :no_flags (nil) do not output flag
+      #     parameters (`--no-flags`)
       #
-      #     @option options [Boolean, nil] :no_flags (nil) do not output flag
-      #       parameters (`--no-flags`)
+      #   @option options [String] :default (nil) use this value if no
+      #     parameter is given by the user
       #
-      #     @option options [String] :default (nil) use this value if no
-      #       parameter is given by the user
+      #   @option options [String] :prefix (nil) behave as if invoked from
+      #     this subdirectory of the working tree
       #
-      #     @option options [String] :prefix (nil) behave as if invoked from
-      #       this subdirectory of the working tree
+      #   @option options [Boolean, nil] :verify (nil) verify that exactly one
+      #     parameter is provided and that it can be resolved to an object
       #
-      #     @option options [Boolean, nil] :verify (nil) verify that exactly one
-      #       parameter is provided and that it can be resolved to an object
+      #   @option options [Boolean, nil] :quiet (nil) do not output an error
+      #     message if the first argument is not a valid object name;
+      #     exit with non-zero status silently
       #
-      #     @option options [Boolean, nil] :quiet (nil) do not output an error
-      #       message if the first argument is not a valid object name;
-      #       exit with non-zero status silently
+      #     Only meaningful with `:verify`.
       #
-      #       Only meaningful with `:verify`.
+      #     Alias: :q
       #
-      #       Alias: :q
+      #   @option options [Boolean, nil] :sq (nil) output a single line
+      #     properly quoted for shell consumption
       #
-      #     @option options [Boolean, nil] :sq (nil) output a single line
-      #       properly quoted for shell consumption
+      #   @option options [Boolean, Integer, String, nil] :short (nil) shorten
+      #     the object name to a unique prefix
       #
-      #     @option options [Boolean, String, nil] :short (nil) shorten the
-      #       object name to a unique prefix
+      #     When `true`, emits `--short` (git default length). When an Integer
+      #     or String, emits `--short=<length>`.
       #
-      #       When `true`, emits `--short` (git default length). When a
-      #       String, emits `--short=<length>`.
+      #   @option options [Boolean, nil] :not (nil) prefix object names with
+      #     `^` and strip `^` from names that already have one
       #
-      #     @option options [Boolean, nil] :not (nil) prefix object names with
-      #       `^` and strip `^` from names that already have one
+      #   @option options [Boolean, String, nil] :abbrev_ref (nil) output a
+      #     non-ambiguous short name of the object
       #
-      #     @option options [Boolean, String, nil] :abbrev_ref (nil) output a
-      #       non-ambiguous short name of the object
+      #     When `true`, emits `--abbrev-ref`. When a String (`"strict"`
+      #     or `"loose"`), emits `--abbrev-ref=<mode>`.
       #
-      #       When `true`, emits `--abbrev-ref`. When a String (`"strict"`
-      #       or `"loose"`), emits `--abbrev-ref=<mode>`.
+      #   @option options [Boolean, nil] :symbolic (nil) output object names
+      #     in a form as close to the original input as possible
       #
-      #     @option options [Boolean, nil] :symbolic (nil) output object names
-      #       in a form as close to the original input as possible
+      #   @option options [Boolean, nil] :symbolic_full_name (nil) like
+      #     `:symbolic` but omit non-ref input and show full refnames
       #
-      #     @option options [Boolean, nil] :symbolic_full_name (nil) like
-      #       `:symbolic` but omit non-ref input and show full refnames
+      #   @option options [String] :output_object_format (nil) translate
+      #     object identifiers to the specified format
       #
-      #     @option options [String] :output_object_format (nil) translate
-      #       object identifiers to the specified format
+      #     Accepted values are `"sha1"`, `"sha256"`, and `"storage"`.
       #
-      #       Accepted values are `"sha1"`, `"sha256"`, and `"storage"`.
+      #   @option options [Boolean, nil] :all (nil) show all refs found in
+      #     `refs/`
       #
-      #     @option options [Boolean, nil] :all (nil) show all refs found in
-      #       `refs/`
+      #   @option options [Boolean, String, nil] :branches (nil) show all
+      #     branches
       #
-      #     @option options [Boolean, String, nil] :branches (nil) show all
-      #       branches
+      #     When `true`, emits `--branches`. When a String, emits
+      #     `--branches=<pattern>`.
       #
-      #       When `true`, emits `--branches`. When a String, emits
-      #       `--branches=<pattern>`.
+      #   @option options [Boolean, String, nil] :tags (nil) show all tags
       #
-      #     @option options [Boolean, String, nil] :tags (nil) show all tags
+      #     When `true`, emits `--tags`. When a String, emits
+      #     `--tags=<pattern>`.
       #
-      #       When `true`, emits `--tags`. When a String, emits
-      #       `--tags=<pattern>`.
+      #   @option options [Boolean, String, nil] :remotes (nil) show all
+      #     remote-tracking branches
       #
-      #     @option options [Boolean, String, nil] :remotes (nil) show all
-      #       remote-tracking branches
+      #     When `true`, emits `--remotes`. When a String, emits
+      #     `--remotes=<pattern>`.
       #
-      #       When `true`, emits `--remotes`. When a String, emits
-      #       `--remotes=<pattern>`.
+      #   @option options [String] :glob (nil) show all refs matching
+      #     the shell glob pattern
       #
-      #     @option options [String] :glob (nil) show all refs matching
-      #       the shell glob pattern
+      #   @option options [String, Array<String>] :exclude (nil) exclude
+      #     refs matching the glob pattern from the next `--all`,
+      #     `--branches`, `--tags`, `--remotes`, or `--glob`
       #
-      #     @option options [String, Array<String>] :exclude (nil) exclude
-      #       refs matching the glob pattern from the next `--all`,
-      #       `--branches`, `--tags`, `--remotes`, or `--glob`
+      #   @option options [String] :disambiguate (nil) show every object
+      #     whose name begins with the given prefix
       #
-      #     @option options [String] :disambiguate (nil) show every object
-      #       whose name begins with the given prefix
+      #   @option options [String] :exclude_hidden (nil) do not include
+      #     refs that would be hidden by the specified protocol
       #
-      #     @option options [String] :exclude_hidden (nil) do not include
-      #       refs that would be hidden by the specified protocol
+      #     Accepted values are `"fetch"`, `"receive"`, and `"uploadpack"`.
+      #     Affects the next `--all` or `--glob` and is cleared after
+      #     processing them.
       #
-      #       Accepted values are `"fetch"`, `"receive"`, and `"uploadpack"`.
-      #       Affects the next `--all` or `--glob` and is cleared after
-      #       processing them.
+      #   @option options [Boolean, nil] :local_env_vars (nil) list the
+      #     `GIT_*` environment variables local to the repository
       #
-      #     @option options [Boolean, nil] :local_env_vars (nil) list the
-      #       `GIT_*` environment variables local to the repository
+      #   @option options [String, Array<String>] :path_format (nil) control
+      #     whether paths output by subsequent path-related options are
+      #     absolute or relative
       #
-      #     @option options [String, Array<String>] :path_format (nil) control
-      #       whether paths output by subsequent path-related options are
-      #       absolute or relative
+      #     Accepted values are `"absolute"` and `"relative"`. May be
+      #     given multiple times; each instance affects the arguments
+      #     that follow it on the command line.
       #
-      #       Accepted values are `"absolute"` and `"relative"`. May be
-      #       given multiple times; each instance affects the arguments
-      #       that follow it on the command line.
+      #   @option options [Boolean, nil] :git_dir (nil) show `$GIT_DIR` if
+      #     defined, otherwise show the path to the `.git` directory
       #
-      #     @option options [Boolean, nil] :git_dir (nil) show `$GIT_DIR` if
-      #       defined, otherwise show the path to the `.git` directory
+      #   @option options [Boolean, nil] :absolute_git_dir (nil) like
+      #     `:git_dir` but always output the canonicalized absolute path
       #
-      #     @option options [Boolean, nil] :absolute_git_dir (nil) like
-      #       `:git_dir` but always output the canonicalized absolute path
+      #   @option options [Boolean, nil] :git_common_dir (nil) show
+      #     `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`
       #
-      #     @option options [Boolean, nil] :git_common_dir (nil) show
-      #       `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`
+      #   @option options [Boolean, nil] :is_inside_git_dir (nil) print
+      #     `"true"` when the current working directory is below the
+      #     repository directory, `"false"` otherwise
       #
-      #     @option options [Boolean, nil] :is_inside_git_dir (nil) print
-      #       `"true"` when the current working directory is below the
-      #       repository directory, `"false"` otherwise
+      #   @option options [Boolean, nil] :is_inside_work_tree (nil) print
+      #     `"true"` when inside the work tree, `"false"` otherwise
       #
-      #     @option options [Boolean, nil] :is_inside_work_tree (nil) print
-      #       `"true"` when inside the work tree, `"false"` otherwise
+      #   @option options [Boolean, nil] :is_bare_repository (nil) print
+      #     `"true"` when the repository is bare, `"false"` otherwise
       #
-      #     @option options [Boolean, nil] :is_bare_repository (nil) print
-      #       `"true"` when the repository is bare, `"false"` otherwise
+      #   @option options [Boolean, nil] :is_shallow_repository (nil) print
+      #     `"true"` when the repository is shallow, `"false"` otherwise
       #
-      #     @option options [Boolean, nil] :is_shallow_repository (nil) print
-      #       `"true"` when the repository is shallow, `"false"` otherwise
+      #   @option options [String] :resolve_git_dir (nil) check if the
+      #     given path is a valid repository or a gitfile that points at
+      #     one and print the location
       #
-      #     @option options [String] :resolve_git_dir (nil) check if the
-      #       given path is a valid repository or a gitfile that points at
-      #       one and print the location
+      #   @option options [String] :git_path (nil) resolve
+      #     `"$GIT_DIR/<path>"` taking relocation variables into account
       #
-      #     @option options [String] :git_path (nil) resolve
-      #       `"$GIT_DIR/<path>"` taking relocation variables into account
+      #   @option options [Boolean, nil] :show_cdup (nil) show the path of
+      #     the top-level directory relative to the current directory
       #
-      #     @option options [Boolean, nil] :show_cdup (nil) show the path of
-      #       the top-level directory relative to the current directory
+      #   @option options [Boolean, nil] :show_prefix (nil) show the path of
+      #     the current directory relative to the top-level directory
       #
-      #     @option options [Boolean, nil] :show_prefix (nil) show the path of
-      #       the current directory relative to the top-level directory
+      #   @option options [Boolean, nil] :show_toplevel (nil) show the
+      #     absolute path of the top-level directory of the working tree
       #
-      #     @option options [Boolean, nil] :show_toplevel (nil) show the
-      #       absolute path of the top-level directory of the working tree
+      #   @option options [Boolean, nil] :show_superproject_working_tree (nil)
+      #     show the absolute path of the root of the superproject's
+      #     working tree if the current repository is a submodule
       #
-      #     @option options [Boolean, nil] :show_superproject_working_tree (nil)
-      #       show the absolute path of the root of the superproject's
-      #       working tree if the current repository is a submodule
+      #   @option options [Boolean, nil] :shared_index_path (nil) show the
+      #     path to the shared index file in split index mode
       #
-      #     @option options [Boolean, nil] :shared_index_path (nil) show the
-      #       path to the shared index file in split index mode
+      #   @option options [Boolean, String, nil] :show_object_format (nil)
+      #     show the object format (hash algorithm) used for the
+      #     repository
       #
-      #     @option options [Boolean, String, nil] :show_object_format (nil)
-      #       show the object format (hash algorithm) used for the
-      #       repository
+      #     When `true`, emits `--show-object-format` (defaults to
+      #     `"storage"`). When a String (`"storage"`, `"input"`, or
+      #     `"output"`), emits `--show-object-format=<mode>`.
       #
-      #       When `true`, emits `--show-object-format` (defaults to
-      #       `"storage"`). When a String (`"storage"`, `"input"`, or
-      #       `"output"`), emits `--show-object-format=<mode>`.
+      #   @option options [Boolean, nil] :show_ref_format (nil) show the
+      #     reference storage format used for the repository
       #
-      #     @option options [Boolean, nil] :show_ref_format (nil) show the
-      #       reference storage format used for the repository
+      #   @option options [String] :since (nil) parse the date string
+      #     and output the corresponding `--max-age=` parameter
       #
-      #     @option options [String] :since (nil) parse the date string
-      #       and output the corresponding `--max-age=` parameter
+      #     Alias: :after
       #
-      #       Alias: :after
+      #   @option options [String] :until (nil) parse the date string
+      #     and output the corresponding `--min-age=` parameter
       #
-      #     @option options [String] :until (nil) parse the date string
-      #       and output the corresponding `--min-age=` parameter
+      #     Alias: :before
       #
-      #       Alias: :before
+      #   @option options [String, nil] :chdir (nil) change to this directory
+      #     before running git; not passed to the git CLI
       #
-      #     @return [Git::CommandLineResult] the result of calling
-      #       `git rev-parse`
+      #   @return [Git::CommandLine::Result] the result of calling
+      #     `git rev-parse`
       #
-      #     @raise [ArgumentError] if unsupported options are provided
+      # @raise [ArgumentError] if unsupported options are provided
       #
-      #     @raise [Git::FailedError] if git exits with a non-zero 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/revert/abort.rb

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

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

@@ -29,7 +29,12 @@ module Git
           flag_option %i[edit e], negatable: true
         end
 
-        # @!method call(*, **)
+        # @!method call(**options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :edit (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(**options)
         #
@@ -45,7 +50,7 @@ module Git
         #     @option options [Boolean, nil] :no_edit (nil) suppress the editor for
         #       the commit message (`--no-edit`)
         #
-        #     @return [Git::CommandLineResult] the result of calling
+        #     @return [Git::CommandLine::Result] the result of calling
         #       `git revert --continue`
         #
         #     @raise [ArgumentError] if unsupported options are provided

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

@@ -29,7 +29,7 @@ module Git
           literal '--quit'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
@@ -37,7 +37,7 @@ module Git
         #     working tree as-is. If no revert is in progress, this is a
         #     no-op and still succeeds.
         #
-        #     @return [Git::CommandLineResult] the result of calling
+        #     @return [Git::CommandLine::Result] the result of calling
         #       `git revert --quit`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status

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

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

data/lib/git/commands/revert/start.rb

@@ -70,7 +70,12 @@ module Git
           operand :commit, repeatable: true, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :edit (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(*commit, **options)
         #
@@ -142,7 +147,7 @@ module Git
         #     @option options [Boolean, nil] :reference (nil) use compact reference
         #       format in the revert commit message instead of the full object name
         #
-        #     @return [Git::CommandLineResult] the result of calling `git revert`
+        #     @return [Git::CommandLine::Result] the result of calling `git revert`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/revert.rb

@@ -19,10 +19,10 @@ module Git
     # - {Revert::Abort} — abort the in-progress revert (`--abort`)
     # - {Revert::Quit} — forget the in-progress revert (`--quit`)
     #
-    # @api private
-    #
     # @see https://git-scm.com/docs/git-revert git-revert documentation
     #
+    # @api private
+    #
     module Revert
     end
   end

data/lib/git/commands/rm.rb

@@ -52,63 +52,62 @@ module Git
         operand :pathspec, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @overload call(*pathspec, **options)
       #
-      #   @overload call(*pathspec, **options)
+      #   Execute the git rm command
       #
-      #     Execute the git rm command
+      #   @param pathspec [Array<String>] files or directories to be removed from the
+      #     repository (relative to the worktree root)
       #
-      #     @param pathspec [Array<String>] files or directories to be removed from the
-      #       repository (relative to the worktree root)
+      #     At least one positional pathspec or the `:pathspec_from_file` option must
+      #     be provided; git will fail at runtime if neither is given.
       #
-      #       At least one positional pathspec or the `:pathspec_from_file` option must
-      #       be provided; git will fail at runtime if neither is given.
+      #   @param options [Hash] command options
       #
-      #     @param options [Hash] command options
+      #   @option options [Boolean, nil] :force (nil) override the up-to-date check and
+      #     remove files with local modifications
       #
-      #     @option options [Boolean, nil] :force (nil) override the up-to-date check and
-      #       remove files with local modifications
+      #     Alias: :f
       #
-      #       Alias: :f
+      #   @option options [Boolean, nil] :dry_run (nil) do not actually remove any files;
+      #     instead, just show if they exist in the index and would otherwise be removed
+      #     by the command
       #
-      #     @option options [Boolean, nil] :dry_run (nil) do not actually remove any files;
-      #       instead, just show if they exist in the index and would otherwise be removed
-      #       by the command
+      #     Alias: :n
       #
-      #       Alias: :n
+      #   @option options [Boolean, nil] :r (nil) allow recursive removal when a leading
+      #     directory name is given
       #
-      #     @option options [Boolean, nil] :r (nil) allow recursive removal when a leading
-      #       directory name is given
+      #   @option options [Boolean, nil] :cached (nil) only remove from the index, keeping
+      #     the working tree files
       #
-      #     @option options [Boolean, nil] :cached (nil) only remove from the index, keeping
-      #       the working tree files
+      #   @option options [Boolean, nil] :ignore_unmatch (nil) exit with a zero status
+      #     even if no files matched
       #
-      #     @option options [Boolean, nil] :ignore_unmatch (nil) exit with a zero status
-      #       even if no files matched
+      #   @option options [Boolean, nil] :sparse (nil) allow updating index entries outside
+      #     of the sparse-checkout cone
       #
-      #     @option options [Boolean, nil] :sparse (nil) allow updating index entries outside
-      #       of the sparse-checkout cone
+      #   @option options [Boolean, nil] :quiet (nil) suppress the one-line-per-file output
       #
-      #     @option options [Boolean, nil] :quiet (nil) suppress the one-line-per-file output
+      #     Alias: :q
       #
-      #       Alias: :q
+      #   @option options [String] :pathspec_from_file (nil) read pathspec from the given
+      #     file, one pathspec element per line; pass `-` to read from standard input
       #
-      #     @option options [String] :pathspec_from_file (nil) read pathspec from the
-      #       given file, one pathspec element per line; pass `-` to read from standard
-      #       input
+      #   @option options [Boolean, nil] :pathspec_file_nul (nil) when used with
+      #     `:pathspec_from_file`, separate pathspec elements with NUL instead of newlines
       #
-      #     @option options [Boolean, nil] :pathspec_file_nul (nil) when used with
-      #       `:pathspec_from_file`, separate pathspec elements with NUL instead of
-      #       newlines
+      #   @return [Git::CommandLine::Result] the result of calling `git rm`
       #
-      #     @return [Git::CommandLineResult] the result of calling `git rm`
+      #   @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/show.rb

@@ -611,7 +611,7 @@ module Git
       #     @option options [IO, #write] :out (nil) stream output to this IO object
       #       instead of capturing it; `result.stdout` will be `''`
       #
-      #     @return [Git::CommandLineResult] the result of calling `git show`
+      #     @return [Git::CommandLine::Result] the result of calling `git show`
       #
       #        If `out:` is given, output is streamed directly to the provided IO
       #        object and `result.stdout` is `''`.

data/lib/git/commands/show_ref/exclude_existing.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'git/commands/base'
-require 'git/commands/show_ref'
 
 module Git
   module Commands
@@ -44,7 +43,7 @@ module Git
 
           # Mode selector: pass `true` (default) to test all refs, or a pattern
           # string to restrict testing to refs whose names start with the pattern.
-          # @see https://git-scm.com/docs/git-show-ref#Documentation/git-show-ref.txt---exclude-existingltpatterngt
+          # See https://git-scm.com/docs/git-show-ref#Documentation/git-show-ref.txt---exclude-existingltpatterngt
           flag_or_value_option :exclude_existing, inline: true
 
           execution_option :timeout
@@ -74,7 +73,7 @@ module Git
         #   @option options [Numeric] :timeout (nil) abort the command after this many
         #     seconds
         #
-        #   @return [Git::CommandLineResult] the result of calling
+        #   @return [Git::CommandLine::Result] the result of calling
         #     `git show-ref --exclude-existing`
         #
         #   @raise [Git::FailedError] if git exits with a non-zero exit status
@@ -99,7 +98,7 @@ module Git
         #
         # @param reader [IO] readable IO connected to git's stdin
         #
-        # @return [Git::CommandLineResult] the result of calling
+        # @return [Git::CommandLine::Result] the result of calling
         #   `git show-ref --exclude-existing`
         #
         # @raise [Git::FailedError] if git exits with a non-zero exit status