Skip to content

Commit c30ac80

Browse files
spacewanderspacewander
authored
Merge pull request #936 from tfendin/multiline_synopsis_fix
Format fix of Synopsis in manuals
2 parents 4de7b34 + 3413eeb commit c30ac80

12 files changed

+105
-206
lines changed

‎man/git-alias.1

+8-35
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,58 @@
1-
.\" generated with Ronn/v0.7.3
2-
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3-
.
4-
.TH "GIT\-ALIAS" "1" "October 2017" "" "Git Extras"
5-
.
1+
.\" generated with Ronn-NG/v0.9.1
2+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3+
.TH "GIT\-ALIAS" "1" "August 2021" "" "Git Extras"
64
.SH "NAME"
75
\fBgit\-alias\fR \- Define, search and show aliases
8-
.
96
.SH "SYNOPSIS"
10-
\fBgit\-alias\fR \fBgit\-alias\fR <search\-pattern> \fBgit\-alias\fR <alias\-name> <command>
11-
.
7+
\fBgit\-alias\fR
8+
.br
9+
\fBgit\-alias\fR <search\-pattern>
10+
.br
11+
\fBgit\-alias\fR <alias\-name> <command>
1212
.SH "DESCRIPTION"
1313
List all aliases, show one alias, or set one (global) alias\.
14-
.
1514
.SH "OPTIONS"
1615
<search\-pattern>
17-
.
1816
.P
1917
The pattern used to search aliases\.
20-
.
2118
.P
2219
<alias\-name>
23-
.
2420
.P
2521
The name of the alias to create\.
26-
.
2722
.P
2823
<command>
29-
.
3024
.P
3125
The command for which you are creating an alias\.
32-
.
3326
.SH "EXAMPLES"
3427
Defining a new alias:
35-
.
3628
.IP "" 4
37-
.
3829
.nf
39-
4030
$ git alias last "cat\-file commit HEAD"
41-
.
4231
.fi
43-
.
4432
.IP "" 0
45-
.
4633
.P
4734
Providing only one argument, \fBgit\-alias\fR searches for aliases matching the given value:
48-
.
4935
.IP "" 4
50-
.
5136
.nf
52-
5337
$ git alias ^la
5438
last = cat\-file commit HEAD
55-
.
5639
.fi
57-
.
5840
.IP "" 0
59-
.
6041
.P
6142
\fBgit\-alias\fR will show all aliases if no argument is given:
62-
.
6343
.IP "" 4
64-
.
6544
.nf
66-
6745
$ git alias
6846
s = status
6947
amend = commit \-\-amend
7048
rank = shortlog \-sn \-\-no\-merges
7149
whatis = show \-s \-\-pretty=\'tformat:%h (%s, %ad)\' \-\-date=short
7250
whois = !sh \-c \'git log \-i \-1 \-\-pretty="format:%an <%ae>
73-
.
7451
.fi
75-
.
7652
.IP "" 0
77-
.
7853
.SH "AUTHOR"
7954
Written by Jonhnny Weslley <\fIjw@jonhnnyweslley\.net\fR>
80-
.
8155
.SH "REPORTING BUGS"
8256
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
83-
.
8457
.SH "SEE ALSO"
8558
<\fIhttps://github\.com/tj/git\-extras\fR>

‎man/git-alias.html

+20-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/git-alias.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ git-alias(1) -- Define, search and show aliases
33

44
## SYNOPSIS
55

6-
`git-alias`
7-
`git-alias` &lt;search-pattern&gt;
8-
`git-alias` &lt;alias-name&gt; &lt;command&gt;
6+
`git-alias`
7+
`git-alias` &lt;search-pattern&gt;
8+
`git-alias` &lt;alias-name&gt; &lt;command&gt;
99

1010
## DESCRIPTION
1111

‎man/git-force-clone.1

+13-28
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,42 @@
1-
.\" generated with Ronn/v0.7.3
2-
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3-
.
4-
.TH "GIT\-FORCE\-CLONE" "1" "October 2017" "" "Git Extras"
5-
.
1+
.\" generated with Ronn-NG/v0.9.1
2+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3+
.TH "GIT\-FORCE\-CLONE" "1" "August 2021" "" "Git Extras"
64
.SH "NAME"
75
\fBgit\-force\-clone\fR \- overwrite local repositories with clone
8-
.
96
.SH "SYNOPSIS"
10-
\fBforce\-clone \-\-help\fR \fBforce\-clone {remote_url} {destination_path}\fR \fBforce\-clone \-\-branch {branch_name} {remote_url} {destination_path}\fR
11-
.
7+
\fBforce\-clone \-\-help\fR
8+
.br
9+
\fBforce\-clone {remote_url} {destination_path}\fR
10+
.br
11+
\fBforce\-clone \-\-branch {branch_name} {remote_url} {destination_path}\fR
1212
.SH "DESCRIPTION"
1313
Provides the basic functionality of \fBgit clone\fR, but if the destination git repository already exists it will force\-reset it to resemble a clone of the remote\.
14-
.
1514
.P
1615
Because it doesn\'t actually delete the directory, it is usually significantly faster than the alternative of deleting the directory and cloning the repository from scratch\.
17-
.
1816
.P
1917
\fBCAUTION\fR: If the repository exists, this will destroy \fIall\fR local work: changed files will be reset, local branches and other remotes will be removed\.
20-
.
2118
.SH "PROCESS"
2219
If \fBtarget\-directory\fR doesn\'t exist or isn\'t a git repository then the arguments will simply be passed through to \fBgit clone\fR\.
23-
.
2420
.P
2521
If \fBtarget\-directory\fR exists and is a git repository then this will:
26-
.
27-
.IP "\(bu" 4
22+
.IP "\[ci]" 4
2823
Remove all remotes
29-
.
30-
.IP "\(bu" 4
24+
.IP "\[ci]" 4
3125
Set the origin remote to \fB{remote_url}\fR and fetch the remote
32-
.
33-
.IP "\(bu" 4
26+
.IP "\[ci]" 4
3427
Discover the default branch, if no branch was specified
35-
.
36-
.IP "\(bu" 4
28+
.IP "\[ci]" 4
3729
Check out the selected branch
38-
.
39-
.IP "\(bu" 4
30+
.IP "\[ci]" 4
4031
Delete all other local branches
41-
.
4232
.IP "" 0
43-
.
4433
.SH "OPTIONS"
4534
\fB{remote_url}\fR \- The URL for a git remote repository of which to make a clone\. \fB{destination_path}\fR \- A path to the local git repository location to clone into\. \fB\-\-branch {branch_name}\fR \- After cloning, checkout this branch\.
46-
.
4735
.SH "EXAMPLES"
4836
\fBgit\-force\-clone \-b master git@github\.com:me/repo\.git \./repo_dir\fR
49-
.
5037
.SH "AUTHOR"
5138
Written by Robin Winslow \fIrobin@robinwinslow\.co\.uk\fR\.
52-
.
5339
.SH "REPORTING BUGS"
5440
\fIhttps://github\.com/tj/git\-extras/issues\fR
55-
.
5641
.SH "SEE ALSO"
5742
\fIhttps://github\.com/tj/git\-extras\fR

‎man/git-force-clone.html

+14-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎man/git-force-clone.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ git-force-clone(1) -- overwrite local repositories with clone
33

44
## SYNOPSIS
55

6-
`force-clone --help`
7-
`force-clone {remote_url} {destination_path}`
8-
`force-clone --branch {branch_name} {remote_url} {destination_path}`
6+
`force-clone --help`
7+
`force-clone {remote_url} {destination_path}`
8+
`force-clone --branch {branch_name} {remote_url} {destination_path}`
99

1010
## DESCRIPTION
1111

‎man/git-psykorebase.1

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
.\" generated with Ronn-NG/v0.9.0
2-
.\" http://github.com/apjanke/ronn-ng/tree/0.9.0
3-
.TH "GIT\-PSYKOREBASE" "1" "March 2020" "" "Git Extras"
1+
.\" generated with Ronn-NG/v0.9.1
2+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3+
.TH "GIT\-PSYKOREBASE" "1" "August 2021" "" "Git Extras"
44
.SH "NAME"
55
\fBgit\-psykorebase\fR \- Rebase a branch with a merge commit
66
.SH "SYNOPSIS"
77
\fBgit\-psykorebase\fR <target_branch> [<feature_branch>] [\-\-no\-ff]
8-
.P
8+
.br
99
\fBgit\-psykorebase\fR \-\-continue
1010
.SH "DESCRIPTION"
1111
Rebase the \fBfeature_branch\fR on top of the \fBtarget_branch\fR, the \fBfeature_branch\fR defaults to the current one\.
@@ -35,12 +35,12 @@ $ git psykorebase \-\-continue
3535
.fi
3636
.IP "" 0
3737
.SH "AUTHOR"
38-
Written by Rémy Hubscher <\fI\%mailto:hubscher\.remy@gmail\.com\fR>
38+
Written by Rémy Hubscher <\fIhubscher\.remy@gmail\.com\fR>
3939
.P
40-
Based on Benoît Bryon <\fI\%mailto:benoit@marmelune\.net\fR> implementation in Python\.
40+
Based on Benoît Bryon <\fIbenoit@marmelune\.net\fR> implementation in Python\.
4141
.SH "REPORTING BUGS"
42-
<\fI\%https://github\.com/tj/git\-extras/issues\fR>
42+
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
4343
.SH "SEE ALSO"
44-
<\fI\%https://github\.com/tj/git\-extras\fR>
44+
<\fIhttps://github\.com/tj/git\-extras\fR>
4545
.P
46-
<\fI\%https://github\.com/benoitbryon/psykorebase\fR>
46+
<\fIhttps://github\.com/benoitbryon/psykorebase\fR>

0 commit comments

Comments
 (0)