Update git-bulk.md: use correct stylization in synopsis (#1163)

* Update git-bulk.md: use correct stylization in synopsis

* update derived documents for git-bulk
This commit is contained in:
wyattscarpenter 2024-09-18 20:17:00 -07:00 committed by GitHub
parent f0671e2733
commit da03b7b133
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 56 additions and 95 deletions

View file

@ -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
@ -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>

View file

@ -1,8 +1,8 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<meta http-equiv='content-type' content='text/html;charset=utf8'>
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
<title>git-bulk(1) - Run git commands on multiple repositories</title>
<style type='text/css' media='all'>
/* style: man */
@ -69,70 +69,71 @@
<li class='tr'>git-bulk(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-bulk</code> - <span class="man-whatis">Run git commands on multiple repositories</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>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</p>
<p><code>git-bulk</code> [-g] ([-a]|[-w <ws-name>]) <git command> </git></ws-name><br>
<code>git-bulk</code> --addworkspace <ws-name> <ws-root-directory> (--from <url or file>) </url></ws-root-directory></ws-name><br>
<code>git-bulk</code> --removeworkspace &lt;ws-name&gt; <br>
<code>git-bulk</code> --addcurrent &lt;ws-name&gt; <br>
<code>git-bulk</code> --purge <br>
<code>git-bulk</code> --listall</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>git bulk adds convenient support for operations that you want to execute on multiple git repositories.</p>
<ul>
<li>simply register workspaces that contain multiple git repos in their directory structure</li>
<li>run any git command on the repositories of the registered workspaces in one command to <code>git bulk</code></li>
<li>use the "guarded mode" to check on each execution</li>
<li>simply register workspaces that contain multiple git repos in their directory structure</li>
<li>run any git command on the repositories of the registered workspaces in one command to <code>git bulk</code>
</li>
<li>use the "guarded mode" to check on each execution</li>
</ul>
<h2 id="OPTIONS">OPTIONS</h2>
<p> -a</p>
<p>-a</p>
<p> Run a git command on all workspaces and their repositories.</p>
<p>Run a git command on all workspaces and their repositories.</p>
<p> -g</p>
<p>-g</p>
<p> Ask the user for confirmation on every execution.</p>
<p>Ask the user for confirmation on every execution.</p>
<p> -w &lt;ws-name&gt;</p>
<p>-w &lt;ws-name&gt;</p>
<p> Run the git command on the specified workspace. The workspace must be registered.</p>
<p>Run the git command on the specified workspace. The workspace must be registered.</p>
<p> &lt;git command&gt;</p>
<p>&lt;git command&gt;</p>
<p> Any git Command you wish to execute on the repositories.</p>
<p>Any git Command you wish to execute on the repositories.</p>
<p> --addworkspace &lt;ws-name&gt; &lt;ws-root-directory&gt; (--from &lt;URL or file&rt;gt;)</p>
<p>--addworkspace <ws-name> <ws-root-directory> (--from <url or file></url></ws-root-directory></ws-name></p>
<p> Register a workspace for bulk operations. All repositories in the directories below &lt;ws-root-directory&gt; get registered under this workspace with the name &lt;ws-name&gt;. &lt;ws-root-directory&gt; must be absolute path.</p>
<p>Register a workspace for bulk operations. All repositories in the directories below &lt;ws-root-directory&gt; get registered under this workspace with the name &lt;ws-name&gt;. &lt;ws-root-directory&gt; must be absolute path.</p>
<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.</p>
<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.</p>
<p> --removeworkspace &lt;ws-name&gt;</p>
<p>--removeworkspace &lt;ws-name&gt;</p>
<p> Remove the workspace with the logical name &lt;ws-name&gt;.</p>
<p>Remove the workspace with the logical name &lt;ws-name&gt;.</p>
<p> --addcurrent &lt;ws-name&gt;</p>
<p>--addcurrent &lt;ws-name&gt;</p>
<p> Adds the current directory as workspace to git bulk operations. The workspace is referenced with its logical name &lt;ws-name&gt;.</p>
<p>Adds the current directory as workspace to git bulk operations. The workspace is referenced with its logical name &lt;ws-name&gt;.</p>
<p> git bulk --purge</p>
<p>git bulk --purge</p>
<p> Removes all defined repository locations.</p>
<p>Removes all defined repository locations.</p>
<p> git bulk --listall</p>
<p>git bulk --listall</p>
<p> List all registered repositories.</p>
<p>List all registered repositories.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
@ -183,7 +184,7 @@ $ git bulk --purge
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Niklas Schlimm &lt;<a href="&#x6d;&#x61;&#105;&#108;&#x74;&#111;&#58;&#x6e;&#x73;&#x31;&#48;&#51;&#x40;&#x68;&#111;&#116;&#x6d;&#97;&#105;&#108;&#x2e;&#100;&#101;" data-bare-link="true">&#110;&#x73;&#x31;&#x30;&#51;&#x40;&#104;&#111;&#116;&#x6d;&#97;&#105;&#108;&#46;&#x64;&#x65;</a>&gt;</p>
<p>Written by Niklas Schlimm &lt;<a href="mailto:ns103@hotmail.de" data-bare-link="true">ns103@hotmail.de</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -193,10 +194,9 @@ $ git bulk --purge
<p>&lt;<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>August 2020</li>
<li class='tc'>September 2024</li>
<li class='tr'>git-bulk(1)</li>
</ol>

View file

@ -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