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

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

@@ -62,7 +62,12 @@ module Git
           operand :value_regex
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :replace_all (nil) command option key;
+        #     see overload docs for the full option list
         #
         #   @overload call(name, value, value_regex = nil, **options)
         #
@@ -103,7 +108,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`
+        #     @return [Git::CommandLine::Result] the result of calling `git config`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

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

@@ -50,9 +50,7 @@ module Git
         # git config --unset exits 5 when trying to unset a non-existent or multi-valued key
         allow_exit_status 0..5
 
-        # @!method call(*, **)
-        #
-        #   @overload call(name, value_regex = nil, **options)
+        # @overload call(name, value_regex = nil, **options)
         #
         #     Execute the `git config --unset` command
         #
@@ -78,11 +76,16 @@ module Git
         #
         #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --unset`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --unset`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 5)
+        #
+        #     @api public
+        def call(*, **)
+          super
+        end
       end
     end
   end

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

@@ -50,7 +50,12 @@ module Git
         # git config --unset-all exits 5 when trying to unset a non-existent key
         allow_exit_status 0..5
 
-        # @!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_regex = nil, **options)
         #
@@ -78,7 +83,7 @@ module Git
         #
         #     @option options [Boolean, nil] :fixed_value (nil) treat the value regex as an exact string
         #
-        #     @return [Git::CommandLineResult] the result of calling `git config --unset-all`
+        #     @return [Git::CommandLine::Result] the result of calling `git config --unset-all`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/describe.rb

@@ -64,9 +64,7 @@ module Git
         operand :commit_ish, repeatable: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(*commit_ish, **options)
+      # @overload call(*commit_ish, **options)
       #
       #     Execute the `git describe` command
       #
@@ -141,7 +139,7 @@ module Git
       #     @option options [Boolean, nil] :first_parent (nil) follow only the
       #       first parent of a merge commit
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git describe`
       #
       #     @raise [ArgumentError] if unsupported options are provided
@@ -150,6 +148,9 @@ module Git
       #       status
       #
       #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/diff.rb

@@ -155,9 +155,7 @@ module Git
       # with --check: 2 = whitespace/conflict-marker errors
       allow_exit_status 0..2
 
-      # @!method call(*, **)
-      #
-      #   @overload call(**options)
+      # @overload call(**options)
       #
       #     Compare the index to the working tree
       #
@@ -166,7 +164,7 @@ module Git
       #
       #     @param options [Hash] command options
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -175,7 +173,7 @@ module Git
       #
       #     @api public
       #
-      #   @overload call(no_index: true, path:, **options)
+      # @overload call(no_index: true, path:, **options)
       #
       #     Compare two paths on the filesystem (outside git)
       #
@@ -191,7 +189,7 @@ module Git
       #
       #     @param options [Hash] command options
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -200,7 +198,7 @@ module Git
       #
       #     @api public
       #
-      #   @overload call(commit = nil, cached:, **options)
+      # @overload call(commit = nil, cached:, **options)
       #
       #     Compare the index to HEAD or the named commit
       #
@@ -213,7 +211,7 @@ module Git
       #
       #     @param options [Hash] command options
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -222,7 +220,7 @@ module Git
       #
       #     @api public
       #
-      #   @overload call(commit, **options)
+      # @overload call(commit, **options)
       #
       #     Compare the working tree to the named commit
       #
@@ -234,7 +232,7 @@ module Git
       #
       #     @param options [Hash] command options
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -243,7 +241,7 @@ module Git
       #
       #     @api public
       #
-      #   @overload call(commit, *commits, **options)
+      # @overload call(commit, *commits, **options)
       #
       #     Compare two or more commits or show a combined diff
       #
@@ -642,7 +640,7 @@ module Git
       #     @option options [Array<String>] :path (nil) zero or more paths
       #       to limit diff to
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git diff`
       #
       #     @raise [ArgumentError] if unsupported options are provided
@@ -651,6 +649,9 @@ module Git
       #       range (exit code > 2)
       #
       #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/diff_files.rb

@@ -153,9 +153,7 @@ module Git
       # git diff-files exits 1 when differences are found (not an error)
       allow_exit_status 0..1
 
-      # @!method call(*, **)
-      #
-      #   @overload call(**options)
+      # @overload call(**options)
       #     Compare the index to the working tree with no path restriction
       #
       #     @param options [Hash] command options
@@ -489,7 +487,7 @@ module Git
       #     @option options [Integer, String] :max_depth (nil) maximum directory depth to
       #       descend for pathspecs
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff-files`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff-files`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -498,14 +496,14 @@ module Git
       #
       #     @api public
       #
-      #   @overload call(*path, **options)
+      # @overload call(*path, **options)
       #     Compare the index to the working tree, limiting output to specific paths
       #
       #     @param path [Array<String>] pathspecs limiting which files are compared
       #
       #     @param options [Hash] command options (same as the no-path overload)
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff-files`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff-files`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -513,6 +511,9 @@ module Git
       #       (exit code > 1)
       #
       #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/diff_index.rb

@@ -161,9 +161,7 @@ module Git
       # git diff-index exits 1 when differences are found (e.g. with --exit-code)
       allow_exit_status 0..1
 
-      # @!method call(*, **)
-      #
-      #   @overload call(tree_ish, **options)
+      # @overload call(tree_ish, **options)
       #     Compare a tree to the index or working tree
       #
       #     @example Compare HEAD to the working tree
@@ -461,13 +459,15 @@ module Git
       #     @option options [Integer, String] :max_depth (nil) maximum directory depth to descend for
       #       each pathspec (tree-to-tree diffs only)
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff-index`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff-index`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
       #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
       #
-      #   @overload call(tree_ish, *paths, **options)
+      #     @api public
+      #
+      # @overload call(tree_ish, *paths, **options)
       #     Compare a tree to the index or working tree, limiting output to specific paths
       #
       #     @example Compare HEAD to the index for a single directory
@@ -484,13 +484,16 @@ module Git
       #
       #     @param options [Hash] command options (same as the single-argument overload)
       #
-      #     @return [Git::CommandLineResult] the result of calling `git diff-index`
+      #     @return [Git::CommandLine::Result] the result of calling `git diff-index`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
       #     @raise [Git::FailedError] if git exits outside the allowed range (exit code > 1)
       #
-      #   @api public
+      #     @api public
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/fetch.rb

@@ -116,9 +116,7 @@ module Git
         operand :refspec, repeatable: true
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(repository = nil, *refspec, **options)
+      # @overload call(repository = nil, *refspec, **options)
       #
       #     Execute the `git fetch` command
       #
@@ -340,13 +338,17 @@ module Git
       #       Pass `true` to capture git fetch output (which is written to stderr
       #       by default).
       #
-      #     @return [Git::CommandLineResult] the result of calling `git fetch`
+      #     @return [Git::CommandLine::Result] the result of calling `git fetch`
       #
       #     @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/fsck.rb

@@ -55,9 +55,7 @@ module Git
       # git fsck uses exit codes 0-7 as bit flags for findings
       allow_exit_status 0..7
 
-      # @!method call(*, **)
-      #
-      #   @overload call(*object, **options)
+      # @overload call(*object, **options)
       #
       #     Execute the `git fsck` command
       #
@@ -123,7 +121,7 @@ module Git
       #     @option options [Boolean, nil] :no_references (nil) skip reference checking
       #       (`--no-references`)
       #
-      #     @return [Git::CommandLineResult] the result of calling `git fsck`
+      #     @return [Git::CommandLine::Result] the result of calling `git fsck`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #
@@ -131,6 +129,10 @@ module Git
       #       (exit code > 7)
       #
       #     @api public
+      #
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/gc.rb

@@ -53,9 +53,7 @@ module Git
         flag_option :keep_largest_pack
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(**options)
+      # @overload call(**options)
       #
       #     Execute the `git gc` command
       #
@@ -120,13 +118,17 @@ module Git
       #
       #       When `true`, `gc.bigPackThreshold` is ignored.
       #
-      #     @return [Git::CommandLineResult] the result of calling `git gc`
+      #     @return [Git::CommandLine::Result] the result of calling `git gc`
       #
       #     @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/grep.rb

@@ -112,9 +112,7 @@ module Git
       # `git grep` exits with 1 when no lines are selected — not an error
       allow_exit_status 0..1
 
-      # @!method call(*, **)
-      #
-      #   @overload call(*tree, **options)
+      # @overload call(*tree, **options)
       #
       #     Execute the `git grep` command
       #
@@ -319,7 +317,7 @@ module Git
       #       Multiple pathspecs may be passed as an Array. Appended to the
       #       command after `--`.
       #
-      #     @return [Git::CommandLineResult] the result of calling `git grep`
+      #     @return [Git::CommandLine::Result] the result of calling `git grep`
       #
       #       Exit status 0 means matches were found; exit status 1 means no
       #       lines were selected (not an error).
@@ -331,8 +329,11 @@ module Git
       #     @raise [Git::FailedError] if git exits outside the allowed range
       #       (exit code > 1)
       #
-      #   @api public
+      #     @api public
       #
+      def call(*, **)
+        super
+      end
     end
   end
 end

data/lib/git/commands/init.rb

@@ -40,9 +40,7 @@ module Git
         operand :directory
       end
 
-      # @!method call(*, **)
-      #
-      #   @overload call(directory = nil, **options)
+      # @overload call(directory = nil, **options)
       #
       #     Execute the `git init` command
       #
@@ -87,13 +85,17 @@ module Git
       #       Pass a string (e.g. `'group'`, `'all'`, `'0660'`) to emit
       #       `--shared=<permissions>`.
       #
-      #     @return [Git::CommandLineResult] the result of calling `git init`
+      #     @return [Git::CommandLine::Result] the result of calling `git init`
       #
       #     @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