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

data/lib/git/commands/maintenance/stop.rb

@@ -28,7 +28,12 @@ module Git
           execution_option :env
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Hash] :env (nil) command option key; see overload docs
+        #     for the full option list
         #
         #   @overload call(**options)
         #
@@ -42,7 +47,7 @@ module Git
         #     @option options [Hash] :env (nil) environment variables to set for the git
         #       process; merged with the default environment; not passed to the git CLI
         #
-        #     @return [Git::CommandLineResult] the result of calling `git maintenance stop`
+        #     @return [Git::CommandLine::Result] the result of calling `git maintenance stop`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/maintenance/unregister.rb

@@ -33,7 +33,12 @@ module Git
           execution_option :env
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, String, nil] :config_file (nil) command option key;
+        #     see overload docs for the full option list
         #
         #   @overload call(**options)
         #
@@ -64,7 +69,7 @@ module Git
         #     @option options [Hash] :env (nil) environment variables to set for the git
         #       process; merged with the default environment; not passed to the git CLI
         #
-        #     @return [Git::CommandLineResult] the result of calling `git maintenance unregister`
+        #     @return [Git::CommandLine::Result] the result of calling `git maintenance unregister`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

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

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

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

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

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

@@ -29,14 +29,14 @@ module Git
           literal '--quit'
         end
 
-        # @!method call(*, **)
+        # @!method call()
         #
         #   @overload call()
         #
         #     Forget about the current merge in progress, leaving the index
         #     and working tree as-is
         #
-        #     @return [Git::CommandLineResult] the result of calling
+        #     @return [Git::CommandLine::Result] the result of calling
         #       `git merge --quit`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status

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

@@ -99,7 +99,12 @@ module Git
           operand :commit, repeatable: true, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :commit (nil) command option key; see overload
+        #     docs for the full option list
         #
         #   @overload call(*commit, **options)
         #
@@ -234,7 +239,7 @@ module Git
         #     @option options [Boolean, nil] :no_overwrite_ignore (nil) abort if the merge result
         #       would overwrite any ignored files (`--no-overwrite-ignore`)
         #
-        #     @return [Git::CommandLineResult] the result of calling `git merge`
+        #     @return [Git::CommandLine::Result] the result of calling `git merge`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/merge.rb

@@ -18,10 +18,10 @@ module Git
     # - {Merge::Quit} — forget the in-progress merge but leave the working tree
     #   as-is (`--quit`)
     #
-    # @api private
-    #
     # @see https://git-scm.com/docs/git-merge git-merge documentation
     #
+    # @api private
+    #
     module Merge
     end
   end

data/lib/git/commands/merge_base.rb

@@ -46,7 +46,12 @@ module Git
       # ancestor (both are valid non-error exits)
       allow_exit_status 0..1
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :octopus (nil) command option key; see overload docs
+      #     for the full option list
       #
       #   @overload call(*commit, **options)
       #
@@ -74,7 +79,7 @@ module Git
       #
       #       Alias: :a
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git merge-base`
       #
       #     @raise [ArgumentError] if unsupported options are provided

data/lib/git/commands/mv.rb

@@ -41,7 +41,12 @@ module Git
         operand :destination, required: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :verbose (nil) command option key; see overload
+      #     docs for the full option list
       #
       #   @overload call(*source, destination, **options)
       #
@@ -67,7 +72,7 @@ module Git
       #
       #     @option options [Boolean, nil] :k (nil) skip move or rename actions which would lead to an error
       #
-      #     @return [Git::CommandLineResult] the result of calling `git mv`
+      #     @return [Git::CommandLine::Result] the result of calling `git mv`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #

data/lib/git/commands/name_rev.rb

@@ -54,7 +54,12 @@ module Git
         operand :commit_ish, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :tags (nil) command option key; see overload docs
+      #     for the full option list
       #
       #   @overload call(*commit_ish, **options)
       #
@@ -103,7 +108,7 @@ module Git
       #     @option options [Boolean, nil] :always (nil) show uniquely abbreviated
       #       commit object as fallback
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git name-rev`
       #
       #     @raise [ArgumentError] if unsupported options are provided

data/lib/git/commands/pull.rb

@@ -112,7 +112,12 @@ module Git
         operand :refspec, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :quiet (nil) command option key; see overload
+      #     docs for the full option list
       #
       #   Execute the `git pull` command
       #
@@ -366,7 +371,7 @@ module Git
       #
       #       If nil, uses the global timeout from {Git::Config}.
       #
-      #     @return [Git::CommandLineResult] the result of calling `git pull`
+      #     @return [Git::CommandLine::Result] the result of calling `git pull`
       #
       #     @raise [ArgumentError] if argument validation fails (e.g., unsupported options
       #       are provided or option values are invalid)

data/lib/git/commands/push.rb

@@ -106,7 +106,12 @@ module Git
         operand :refspec, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :all (nil) command option key; see overload docs
+      #     for the full option list
       #
       #   Execute the `git push` command
       #
@@ -235,7 +240,7 @@ module Git
       #
       #     @option options [Integer] :timeout (nil) maximum seconds to wait for the command to complete
       #
-      #     @return [Git::CommandLineResult] the result of calling `git push`
+      #     @return [Git::CommandLine::Result] the result of calling `git push`
       #
       #     @raise [ArgumentError] if unsupported options are provided
       #

data/lib/git/commands/read_tree.rb

@@ -67,7 +67,12 @@ module Git
         operand :tree_ish, repeatable: true
       end
 
-      # @!method call(*, **)
+      # @!method call(*, **options)
+      #
+      #   @param options [Hash] command options
+      #
+      #   @option options [Boolean, nil] :m (nil) command option key; see overload docs
+      #     for the full option list
       #
       #   @overload call(*tree_ish, **options)
       #
@@ -137,7 +142,7 @@ module Git
       #
       #       Alias: `:q`
       #
-      #     @return [Git::CommandLineResult] the result of calling
+      #     @return [Git::CommandLine::Result] the result of calling
       #       `git read-tree`
       #
       #     @raise [ArgumentError] if unsupported options are provided

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

@@ -46,7 +46,12 @@ module Git
           operand :url, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [String, Array<String>] :track (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, url, **options)
         #
@@ -80,7 +85,7 @@ module Git
         #
         #       Common values are `'fetch'` and `'push'`.
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote add`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote add`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #

data/lib/git/commands/remote/get_url.rb

@@ -41,7 +41,7 @@ module Git
           operand :name, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*)
         #
         #   @overload call(name, **options)
         #
@@ -55,11 +55,13 @@ module Git
         #
         #     @option options [Boolean, nil] :all (nil) return all configured URLs instead of only the first one
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote get-url`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote get-url`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

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

@@ -31,7 +31,7 @@ module Git
           flag_option %i[verbose v]
         end
 
-        # @!method call(*, **)
+        # @!method call(*)
         #
         #   @overload call(**options)
         #
@@ -43,11 +43,13 @@ module Git
         #
         #       Alias: :v
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/prune.rb

@@ -36,7 +36,7 @@ module Git
           operand :name, repeatable: true, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*)
         #
         #   @overload call(*name, **options)
         #
@@ -50,11 +50,13 @@ module Git
         #
         #       Alias: :n
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote prune`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote prune`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/remove.rb

@@ -35,7 +35,7 @@ module Git
           operand :name, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*)
         #
         #   @overload call(name)
         #
@@ -43,9 +43,11 @@ module Git
         #
         #     @param name [String] the remote name to remove
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote remove`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote remove`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/rename.rb

@@ -42,7 +42,7 @@ module Git
           operand :new, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*)
         #
         #   @overload call(old, new, **options)
         #
@@ -58,11 +58,13 @@ module Git
         #
         #     @option options [Boolean, nil] :no_progress (nil) suppress progress output (`--no-progress`)
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote rename`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote rename`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/set_branches.rb

@@ -38,7 +38,12 @@ module Git
           operand :branch, repeatable: true, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :add (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, *branch, **options)
         #
@@ -52,11 +57,13 @@ module Git
         #
         #     @option options [Boolean, nil] :add (nil) append the given branches instead of replacing them
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-branches`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-branches`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/set_head.rb

@@ -39,7 +39,12 @@ module Git
           operand :branch
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :auto (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, branch)
         #
@@ -49,12 +54,12 @@ module Git
         #
         #     @param branch [String] the branch to set as the remote HEAD
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-head`
-        #
-        #     @raise [ArgumentError] if unsupported options are provided
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-head`
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
         #
+        #     @api public
+        #
         #   @overload call(name, **options)
         #
         #     Detect or delete the remote's HEAD symbolic ref
@@ -71,11 +76,13 @@ module Git
         #
         #       Mutually exclusive with `:auto`. Alias: :d
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-head`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-head`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/set_url.rb

@@ -44,7 +44,12 @@ module Git
           operand :oldurl
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :push (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, newurl, oldurl = nil, **options)
         #
@@ -60,11 +65,13 @@ module Git
         #
         #     @option options [Boolean, nil] :push (nil) update push URLs instead of fetch URLs
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-url`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-url`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/set_url_add.rb

@@ -38,7 +38,12 @@ module Git
           operand :newurl, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :push (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, newurl, **options)
         #
@@ -52,9 +57,13 @@ module Git
         #
         #     @option options [Boolean, nil] :push (nil) add a push URL instead of a fetch URL
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-url --add`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-url --add`
+        #
+        #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/set_url_delete.rb

@@ -39,7 +39,12 @@ module Git
           operand :url, required: true
         end
 
-        # @!method call(*, **)
+        # @!method call(*, **options)
+        #
+        #   @param options [Hash] command options
+        #
+        #   @option options [Boolean, nil] :push (nil) command option key; see
+        #     overload docs for the full option list
         #
         #   @overload call(name, url, **options)
         #
@@ -53,11 +58,13 @@ module Git
         #
         #     @option options [Boolean, nil] :push (nil) delete push URLs instead of fetch URLs
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote set-url --delete`
+        #     @return [Git::CommandLine::Result] the result of calling `git remote set-url --delete`
         #
         #     @raise [ArgumentError] if unsupported options are provided
         #
         #     @raise [Git::FailedError] if git exits with a non-zero exit status
+        #
+        #     @api public
       end
     end
   end

data/lib/git/commands/remote/show.rb

@@ -42,29 +42,35 @@ module Git
           operand :name, repeatable: true, required: true
         end
 
-        # @!method call(*, **)
+        # @overload call(*name, **options)
         #
-        #   @overload call(*name, **options)
+        #   Execute the `git remote show` command
         #
-        #     Execute the `git remote show` command
+        #   @param name [Array<String>] one or more remote names to inspect
         #
-        #     @param name [Array<String>] one or more remote names to inspect
+        #   @param options [Hash] command options
         #
-        #     @param options [Hash] command options
+        #   @option options [Boolean, nil] :verbose (nil) show the remote URL after
+        #     the remote name
         #
-        #     @option options [Boolean, nil] :verbose (nil) show the remote URL after the remote name
+        #     Alias: :v
         #
-        #       Alias: :v
+        #   @option options [Boolean, nil] :n (nil) do not query remote heads with
+        #     `git ls-remote`
         #
-        #     @option options [Boolean, nil] :n (nil) do not query remote heads with `git ls-remote`
+        #     Uses cached information instead of contacting the remote server.
         #
-        #       Uses cached information instead of contacting the remote server.
+        #   @return [Git::CommandLine::Result] the result of calling `git remote show`
         #
-        #     @return [Git::CommandLineResult] the result of calling `git remote show`
+        # @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