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

data/lib/git/commands/cat_file/raw.rb

@@ -21,12 +21,12 @@ module Git
       # For queries across multiple objects, use {CatFile::Batch}.
       # For filter-processed content, use {CatFile::Filtered}.
       #
+      # @note `arguments` block audited against https://git-scm.com/docs/git-cat-file/2.53.0
+      #
       # @see Git::Commands::CatFile
       #
       # @see https://git-scm.com/docs/git-cat-file git-cat-file documentation
       #
-      # @note `arguments` block audited against https://git-scm.com/docs/git-cat-file/2.53.0
-      #
       # @api private
       #
       class Raw < Base
@@ -34,28 +34,28 @@ module Git
           literal 'cat-file'
 
           # Exit 0 if object exists and is valid; exit 1 otherwise (no output)
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--e
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--e
           flag_option :e
 
           # Pretty-print the object content based on its type
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--p
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--p
           flag_option :p
 
           # Print the object type (`blob`, `tree`, `commit`, or `tag`)
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--t
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--t
           flag_option :t
 
           # Print the object size in bytes
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--s
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt--s
           flag_option :s
 
           # Allow -t and -s to query broken or corrupt objects of unknown type;
           # rejected by git in any other mode — enforced by constraint below
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt---allow-unknown-type
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt---allow-unknown-type
           flag_option :allow_unknown_type
 
           # Map committer/author identities through the mailmap before reporting size
-          # @see https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt---use-mailmap
+          # See https://git-scm.com/docs/git-cat-file#Documentation/git-cat-file.txt---use-mailmap
           flag_option :use_mailmap, negatable: true
 
           # Stream stdout to this IO object instead of buffering in memory.
@@ -96,7 +96,7 @@ module Git
         #
         #   @option options [Boolean, nil] :no_use_mailmap (nil) suppress mailmap remapping (`--no-use-mailmap`)
         #
-        #   @return [Git::CommandLineResult] the result of calling `git cat-file`
+        #   @return [Git::CommandLine::Result] the result of calling `git cat-file`
         #
         #     Exit status 0 means the object exists; exit status 1 means it does not
         #
@@ -120,7 +120,7 @@ module Git
         #
         #   @option options [Boolean, nil] :no_use_mailmap (nil) suppress mailmap remapping (`--no-use-mailmap`)
         #
-        #   @return [Git::CommandLineResult] the result of calling `git cat-file`
+        #   @return [Git::CommandLine::Result] the result of calling `git cat-file`
         #
         #     Stdout contains the object type string
         #
@@ -144,7 +144,7 @@ module Git
         #
         #   @option options [Boolean, nil] :no_use_mailmap (nil) suppress mailmap remapping (`--no-use-mailmap`)
         #
-        #   @return [Git::CommandLineResult] the result of calling `git cat-file`
+        #   @return [Git::CommandLine::Result] the result of calling `git cat-file`
         #
         #     Stdout contains the object size as a decimal string
         #
@@ -165,7 +165,7 @@ module Git
         #
         #   @option options [Boolean, nil] :no_use_mailmap (nil) suppress mailmap remapping (`--no-use-mailmap`)
         #
-        #   @return [Git::CommandLineResult] the result of calling `git cat-file`
+        #   @return [Git::CommandLine::Result] the result of calling `git cat-file`
         #
         #     Stdout contains the formatted object content
         #
@@ -186,7 +186,7 @@ module Git
         #
         #   @option options [Boolean, nil] :no_use_mailmap (nil) suppress mailmap remapping (`--no-use-mailmap`)
         #
-        #   @return [Git::CommandLineResult] the result of calling `git cat-file`
+        #   @return [Git::CommandLine::Result] the result of calling `git cat-file`
         #
         #     Stdout contains the raw object content
         #

data/lib/git/commands/cat_file.rb

@@ -17,10 +17,6 @@ module Git
     # - {CatFile::Batch} — objects fed via stdin; all batch streaming modes
     #   (`--batch`, `--batch-check`, `--batch-command`)
     #
-    # @api private
-    #
-    # @see https://git-scm.com/docs/git-cat-file git-cat-file documentation
-    #
     # @example Check whether an object exists
     #   cmd = Git::Commands::CatFile::Raw.new(lib)
     #   result = cmd.call('HEAD', e: true)
@@ -43,6 +39,10 @@ module Git
     #   result.stdout
     #   # => "abc1234... commit 250\nabc5678... tag 143\n"
     #
+    # @see https://git-scm.com/docs/git-cat-file git-cat-file documentation
+    #
+    # @api private
+    #
     module CatFile
     end
   end

data/lib/git/commands/checkout/branch.rb

@@ -53,9 +53,7 @@ module Git
           operand :branch
         end
 
-        # @!method call(*, **)
-        #
-        #   @overload call(branch = nil, **options)
+        # @overload call(branch = nil, **options)
         #
         #     Execute the git checkout command for branch switching
         #
@@ -138,13 +136,17 @@ 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 checkout`
+        #     @return [Git::CommandLine::Result] the result of calling `git checkout`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @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/checkout/files.rb

@@ -47,9 +47,7 @@ module Git
           value_option :pathspec, as_operand: true, repeatable: true
         end
 
-        # @!method call(*, **)
-        #
-        #   @overload call(tree_ish = nil, **options)
+        # @overload call(tree_ish = nil, **options)
         #
         #     Execute the git checkout command for restoring files
         #
@@ -101,7 +99,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 checkout`
+        #     @return [Git::CommandLine::Result] the result of calling `git checkout`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
@@ -109,6 +107,9 @@ module Git
         #
         #   @api public
         #
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/checkout.rb

@@ -12,10 +12,6 @@ module Git
     # - {Checkout::Branch} — switch branches or create and switch to a new branch
     # - {Checkout::Files} — restore working tree files from a given tree-ish
     #
-    # @api private
-    #
-    # @see https://git-scm.com/docs/git-checkout git-checkout documentation
-    #
     # @example Switch to an existing branch
     #   cmd = Git::Commands::Checkout::Branch.new(lib)
     #   cmd.call('main')
@@ -32,6 +28,10 @@ module Git
     #   cmd = Git::Commands::Checkout::Files.new(lib)
     #   cmd.call('main', pathspec: ['lib/my_file.rb'])
     #
+    # @see https://git-scm.com/docs/git-checkout git-checkout documentation
+    #
+    # @api private
+    #
     module Checkout
     end
   end

data/lib/git/commands/checkout_index.rb

@@ -42,9 +42,7 @@ module Git
         operand :file, required: false, repeatable: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(*file, **options)
+      # @overload call(*file, **options)
       #
       #     Execute the `git checkout-index` command
       #
@@ -92,7 +90,7 @@ module Git
       #     @option options [Boolean, nil] :ignore_skip_worktree_bits (nil) check out
       #       all files, including those with the skip-worktree bit set
       #
-      #     @return [Git::CommandLineResult] the result of calling `git checkout-index`
+      #     @return [Git::CommandLine::Result] the result of calling `git checkout-index`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -100,6 +98,9 @@ module Git
       #
       #   @api public
       #
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/clean.rb

@@ -43,9 +43,7 @@ module Git
         value_option :pathspec, as_operand: true, repeatable: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(**options)
+      # @overload call(**options)
       #
       #     Execute the git clean command
       #
@@ -88,13 +86,17 @@ module Git
       #     @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 clean`
+      #     @return [Git::CommandLine::Result] the result of calling `git clean`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
       #     @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/clone.rb

@@ -68,9 +68,7 @@ module Git
         execution_option :chdir
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(repository, directory = nil, **options)
+      # @overload call(repository, directory = nil, **options)
       #
       #     Execute the `git clone` command
       #
@@ -227,7 +225,7 @@ module Git
       #     @option options [String, nil] :chdir (nil) the working directory in which to
       #       run the git clone command
       #
-      #     @return [Git::CommandLineResult] the result of calling `git clone`
+      #     @return [Git::CommandLine::Result] the result of calling `git clone`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -235,6 +233,9 @@ module Git
       #
       #   @api public
       #
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/commit.rb

@@ -93,9 +93,7 @@ module Git
         operand :pathspec, repeatable: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(*pathspec, **options)
+      # @overload call(*pathspec, **options)
       #
       #     Execute the `git commit` command.
       #
@@ -259,7 +257,7 @@ module Git
       #     @option options [Boolean, nil] :pathspec_file_nul (nil) pathspec elements in
       #       `:pathspec_from_file` are NUL-separated instead of newline-separated
       #
-      #     @return [Git::CommandLineResult] the result of calling `git commit`
+      #     @return [Git::CommandLine::Result] the result of calling `git commit`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -267,6 +265,9 @@ module Git
       #
       #   @api public
       #
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/commit_tree.rb

@@ -46,9 +46,7 @@ module Git
         operand :tree, required: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(tree, **options)
+      # @overload call(tree, **options)
       #
       #     Execute the `git commit-tree` command
       #
@@ -84,7 +82,7 @@ module Git
       #       Use `"-"` to read from standard input. Can be given more than
       #       once; each file's content becomes its own paragraph.
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git commit-tree`
       #
       #     @raise [ArgumentError] if unsupported options are provided
@@ -95,6 +93,9 @@ module Git
       #       status
       #
       #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/config_option_syntax/add.rb

@@ -44,9 +44,7 @@ module Git
           operand :value, required: true
         end
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, value, **options)
+        # @overload call(name, value, **options)
         #
         #     Execute the `git config --add` command
         #
@@ -72,11 +70,16 @@ module Git
         #
         #     @option options [String] :type (nil) ensure the value conforms to the given type
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --add`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --add`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @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/config_option_syntax/get.rb

@@ -63,9 +63,7 @@ module Git
         # git config --get exits 1 when the key is not found (not an error)
         allow_exit_status 0..1
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, value_regex = nil, **options)
+        # @overload call(name, value_regex = nil, **options)
         #
         #     Execute the `git config --get` command
         #
@@ -106,11 +104,17 @@ module Git
         #
         #     @option options [String] :default (nil) default value when the key is not found
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
-        #     @raise [Git::FailedError] if git exits outside the allowed status range (0..1)
+        #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+        #
+        #     @api public
+        #
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/config_option_syntax/get_all.rb

@@ -59,9 +59,7 @@ module Git
         # git config --get-all exits 1 when the key is not found (not an error)
         allow_exit_status 0..1
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, value_regex = nil, **options)
+        # @overload call(name, value_regex = nil, **options)
         #
         #     Execute the `git config --get-all` command
         #
@@ -104,11 +102,16 @@ module Git
         #
         #       Alias: :z
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get-all`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get-all`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+        #
+        #     @api public
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/config_option_syntax/get_color.rb

@@ -48,9 +48,7 @@ module Git
           operand :default
         end
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, default = nil, **options)
+        # @overload call(name, default = nil, **options)
         #
         #     Execute the `git config --get-color` command
         #
@@ -80,11 +78,17 @@ module Git
         #     @option options [Boolean, nil] :no_includes (nil) suppress include directive processing
         #       (`--no-includes`)
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get-color`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get-color`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @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/config_option_syntax/get_color_bool.rb

@@ -52,9 +52,7 @@ module Git
         # git config --get-colorbool exits 0 for color=yes, 1 for color=no
         allow_exit_status 0..1
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, stdout_is_tty = nil, **options)
+        # @overload call(name, stdout_is_tty = nil, **options)
         #
         #     Execute the `git config --get-colorbool` command
         #
@@ -82,11 +80,16 @@ module Git
         #
         #     @option options [Boolean, nil] :no_includes (nil) disable include directive processing (`--no-includes`)
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get-colorbool`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get-colorbool`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+        #
+        #     @api public
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/config_option_syntax/get_regexp.rb

@@ -60,9 +60,7 @@ module Git
         # git config --get-regexp exits 1 when no match is found (not an error)
         allow_exit_status 0..1
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name_regex, value_regex = nil, **options)
+        # @overload call(name_regex, value_regex = nil, **options)
         #
         #     Execute the `git config --get-regexp` command
         #
@@ -104,11 +102,17 @@ module Git
         #
         #     @option options [Boolean, nil] :name_only (nil) output only the names of config keys
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get-regexp`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get-regexp`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+        #
+        #     @api public
+        #
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/config_option_syntax/get_urlmatch.rb

@@ -57,9 +57,7 @@ module Git
         # git config --get-urlmatch exits 1 when no match is found (not an error)
         allow_exit_status 0..1
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, url, **options)
+        # @overload call(name, url, **options)
         #
         #     Execute the `git config --get-urlmatch` command
         #
@@ -96,11 +94,17 @@ module Git
         #
         #     @option options [Boolean, nil] :show_scope (nil) show the scope of each config entry
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --get-urlmatch`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --get-urlmatch`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
+        #
+        #     @api public
+        #
+        def call(*, **)
+          super
+        end
       end
     end
   end

data/lib/git/commands/config_option_syntax/list.rb

@@ -56,9 +56,7 @@ module Git
           value_option :type, inline: true
         end
 
-        # @!method call(*, **)
-        #
-        #   @overload call(**options)
+        # @overload call(**options)
         #
         #     Execute the `git config --list` command
         #
@@ -96,11 +94,17 @@ module Git
         #
         #     @option options [String] :type (nil) ensure values conform to the given type
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --list`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --list`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @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/config_option_syntax/remove_section.rb

@@ -39,7 +39,12 @@ module Git
           operand :name, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :global (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, **options)
         #
@@ -63,7 +68,7 @@ module Git
         #
         #     @option options [String] :blob (nil) read from the specified blob
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --remove-section`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --remove-section`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/config_option_syntax/rename_section.rb

@@ -41,7 +41,12 @@ module Git
           operand :new_name, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :global (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(old_name, new_name, **options)
         #
@@ -67,7 +72,7 @@ module Git
         #
         #     @option options [String] :blob (nil) read from the specified blob
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --rename-section`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --rename-section`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/config_option_syntax/replace_all.rb

@@ -56,7 +56,12 @@ module Git
           operand :value_regex
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :global (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, value, value_regex = nil, **options)
         #
@@ -93,7 +98,7 @@ module Git
         #     @option options [Boolean, nil] :no_type (nil) unset the previously set type specifier;
         #       `true` emits `--no-type`
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --replace-all`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --replace-all`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #