Skip to content

Commit

Permalink
Update git-bulk.md: use correct stylization in synopsis (#1163)
Browse files Browse the repository at this point in the history
* Update git-bulk.md: use correct stylization in synopsis

* update derived documents for git-bulk
  • Loading branch information
wyattscarpenter authored Sep 19, 2024
1 parent f0671e2 commit da03b7b
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 95 deletions.
67 changes: 14 additions & 53 deletions man/git-bulk.1
Original file line number Diff line number Diff line change
@@ -1,104 +1,69 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-BULK" "1" "August 2020" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-BULK" "1" "September 2024" "" "Git Extras"
.SH "NAME"
\fBgit\-bulk\fR \- Run git commands on multiple repositories
.
.SH "SYNOPSIS"
git bulk [\-g] ([\-a]|[\-w <ws\-name>]) <git command>
.
\fBgit\-bulk\fR [\-g] ([\-a]|[\-w
.br
git bulk \-\-addworkspace <ws\-name> <ws\-root\-directory> (\-\-from <URL or file>)
.
\fBgit\-bulk\fR \-\-addworkspace
.br
git bulk \-\-removeworkspace <ws\-name>
.
\fBgit\-bulk\fR \-\-removeworkspace <ws\-name>
.br
git bulk \-\-addcurrent <ws\-name>
.
\fBgit\-bulk\fR \-\-addcurrent <ws\-name>
.br
git bulk \-\-purge
.
\fBgit\-bulk\fR \-\-purge
.br
git bulk \-\-listall
.
\fBgit\-bulk\fR \-\-listall
.SH "DESCRIPTION"
git bulk adds convenient support for operations that you want to execute on multiple git repositories\.
.
.IP "\(bu" 4
.IP "\[ci]" 4
simply register workspaces that contain multiple git repos in their directory structure
.
.IP "\(bu" 4
.IP "\[ci]" 4
run any git command on the repositories of the registered workspaces in one command to \fBgit bulk\fR
.
.IP "\(bu" 4
.IP "\[ci]" 4
use the "guarded mode" to check on each execution
.
.IP "" 0
.
.SH "OPTIONS"
\-a
.
.P
Run a git command on all workspaces and their repositories\.
.
.P
\-g
.
.P
Ask the user for confirmation on every execution\.
.
.P
\-w <ws\-name>
.
.P
Run the git command on the specified workspace\. The workspace must be registered\.
.
.P
<git command>
.
.P
Any git Command you wish to execute on the repositories\.
.
.P
\-\-addworkspace <ws\-name> <ws\-root\-directory> (\-\-from <URL or file&rt;gt;)
.
\-\-addworkspace
.P
Register a workspace for bulk operations\. All repositories in the directories below <ws\-root\-directory> get registered under this workspace with the name <ws\-name>\. <ws\-root\-directory> must be absolute path\.
.
.P
With option \'\-\-from\' the URL to a single repository or a file containing multiple URLs can be added and they will be cloned directly into the workspace\. Suitable for the initial setup of a multi\-repo project\.
.
With option '\-\-from' the URL to a single repository or a file containing multiple URLs can be added and they will be cloned directly into the workspace\. Suitable for the initial setup of a multi\-repo project\.
.P
\-\-removeworkspace <ws\-name>
.
.P
Remove the workspace with the logical name <ws\-name>\.
.
.P
\-\-addcurrent <ws\-name>
.
.P
Adds the current directory as workspace to git bulk operations\. The workspace is referenced with its logical name <ws\-name>\.
.
.P
git bulk \-\-purge
.
.P
Removes all defined repository locations\.
.
.P
git bulk \-\-listall
.
.P
List all registered repositories\.
.
.SH "EXAMPLES"
.
.nf

Register a workspace so that git bulk knows about it:

$ git bulk \-\-addworkspace personal ~/workspaces/personal
Expand Down Expand Up @@ -142,14 +107,10 @@ $ git bulk \-\-removeworkspace personal
Remove all registered workspaces:

$ git bulk \-\-purge
.
.fi
.
.SH "AUTHOR"
Written by Niklas Schlimm <\fIns103@hotmail\.de\fR>
.
.SH "REPORTING BUGS"
<https://github\.com/nschlimm/git\-bulk>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>
72 changes: 36 additions & 36 deletions man/git-bulk.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions man/git-bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ git-bulk(1) -- Run git commands on multiple repositories

## SYNOPSIS

git bulk [-g] ([-a]|[-w &lt;ws-name&gt;]) &lt;git command&gt; <br/>
git bulk --addworkspace &lt;ws-name&gt; &lt;ws-root-directory&gt; (--from &lt;URL or file&gt;) <br/>
git bulk --removeworkspace &lt;ws-name&gt; <br/>
git bulk --addcurrent &lt;ws-name&gt; <br/>
git bulk --purge <br/>
git bulk --listall
`git-bulk` [-g] ([-a]|[-w &lt;ws-name&gt;]) &lt;git command&gt; <br/>
`git-bulk` --addworkspace &lt;ws-name&gt; &lt;ws-root-directory&gt; (--from &lt;URL or file&gt;) <br/>
`git-bulk` --removeworkspace &lt;ws-name&gt; <br/>
`git-bulk` --addcurrent &lt;ws-name&gt; <br/>
`git-bulk` --purge <br/>
`git-bulk` --listall

## DESCRIPTION

Expand Down

0 comments on commit da03b7b

Please sign in to comment.