Skip to content

Format fix of Synopsis in manuals #936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spacewander merged 1 commit into from
Aug 19, 2021
Merged

Format fix of Synopsis in manuals #936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 8 additions & 35 deletions man/git-alias.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,85 +1,58 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-ALIAS" "1" "October 2017" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-ALIAS" "1" "August 2021" "" "Git Extras"
.SH "NAME"
\fBgit\-alias\fR \- Define, search and show aliases
.
.SH "SYNOPSIS"
\fBgit\-alias\fR \fBgit\-alias\fR <search\-pattern> \fBgit\-alias\fR <alias\-name> <command>
.
\fBgit\-alias\fR
.br
\fBgit\-alias\fR <search\-pattern>
.br
\fBgit\-alias\fR <alias\-name> <command>
.SH "DESCRIPTION"
List all aliases, show one alias, or set one (global) alias\.
.
.SH "OPTIONS"
<search\-pattern>
.
.P
The pattern used to search aliases\.
.
.P
<alias\-name>
.
.P
The name of the alias to create\.
.
.P
<command>
.
.P
The command for which you are creating an alias\.
.
.SH "EXAMPLES"
Defining a new alias:
.
.IP "" 4
.
.nf

$ git alias last "cat\-file commit HEAD"
.
.fi
.
.IP "" 0
.
.P
Providing only one argument, \fBgit\-alias\fR searches for aliases matching the given value:
.
.IP "" 4
.
.nf

$ git alias ^la
last = cat\-file commit HEAD
.
.fi
.
.IP "" 0
.
.P
\fBgit\-alias\fR will show all aliases if no argument is given:
.
.IP "" 4
.
.nf

$ git alias
s = status
amend = commit \-\-amend
rank = shortlog \-sn \-\-no\-merges
whatis = show \-s \-\-pretty=\'tformat:%h (%s, %ad)\' \-\-date=short
whois = !sh \-c \'git log \-i \-1 \-\-pretty="format:%an <%ae>
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by Jonhnny Weslley <\fIjw@jonhnnyweslley\.net\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>
40 changes: 20 additions & 20 deletions man/git-alias.html
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions man/git-alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ git-alias(1) -- Define, search and show aliases

## SYNOPSIS

`git-alias`
`git-alias` &lt;search-pattern&gt;
`git-alias` &lt;alias-name&gt; &lt;command&gt;
`git-alias`
`git-alias` &lt;search-pattern&gt;
`git-alias` &lt;alias-name&gt; &lt;command&gt;

## DESCRIPTION

Expand Down
41 changes: 13 additions & 28 deletions man/git-force-clone.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,42 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-FORCE\-CLONE" "1" "October 2017" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-FORCE\-CLONE" "1" "August 2021" "" "Git Extras"
.SH "NAME"
\fBgit\-force\-clone\fR \- overwrite local repositories with clone
.
.SH "SYNOPSIS"
\fBforce\-clone \-\-help\fR \fBforce\-clone {remote_url} {destination_path}\fR \fBforce\-clone \-\-branch {branch_name} {remote_url} {destination_path}\fR
.
\fBforce\-clone \-\-help\fR
.br
\fBforce\-clone {remote_url} {destination_path}\fR
.br
\fBforce\-clone \-\-branch {branch_name} {remote_url} {destination_path}\fR
.SH "DESCRIPTION"
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\.
.
.P
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\.
.
.P
\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\.
.
.SH "PROCESS"
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\.
.
.P
If \fBtarget\-directory\fR exists and is a git repository then this will:
.
.IP "\(bu" 4
.IP "\[ci]" 4
Remove all remotes
.
.IP "\(bu" 4
.IP "\[ci]" 4
Set the origin remote to \fB{remote_url}\fR and fetch the remote
.
.IP "\(bu" 4
.IP "\[ci]" 4
Discover the default branch, if no branch was specified
.
.IP "\(bu" 4
.IP "\[ci]" 4
Check out the selected branch
.
.IP "\(bu" 4
.IP "\[ci]" 4
Delete all other local branches
.
.IP "" 0
.
.SH "OPTIONS"
\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\.
.
.SH "EXAMPLES"
\fBgit\-force\-clone \-b master git@github\.com:me/repo\.git \./repo_dir\fR
.
.SH "AUTHOR"
Written by Robin Winslow \fIrobin@robinwinslow\.co\.uk\fR\.
.
.SH "REPORTING BUGS"
\fIhttps://github\.com/tj/git\-extras/issues\fR
.
.SH "SEE ALSO"
\fIhttps://github\.com/tj/git\-extras\fR
29 changes: 14 additions & 15 deletions man/git-force-clone.html
View file
Open in desktop

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

6 changes: 3 additions & 3 deletions man/git-force-clone.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ git-force-clone(1) -- overwrite local repositories with clone

## SYNOPSIS

`force-clone --help`
`force-clone {remote_url} {destination_path}`
`force-clone --branch {branch_name} {remote_url} {destination_path}`
`force-clone --help`
`force-clone {remote_url} {destination_path}`
`force-clone --branch {branch_name} {remote_url} {destination_path}`

## DESCRIPTION

Expand Down
18 changes: 9 additions & 9 deletions man/git-psykorebase.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.\" generated with Ronn-NG/v0.9.0
.\" http://github.com/apjanke/ronn-ng/tree/0.9.0
.TH "GIT\-PSYKOREBASE" "1" "March 2020" "" "Git Extras"
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-PSYKOREBASE" "1" "August 2021" "" "Git Extras"
.SH "NAME"
\fBgit\-psykorebase\fR \- Rebase a branch with a merge commit
.SH "SYNOPSIS"
\fBgit\-psykorebase\fR <target_branch> [<feature_branch>] [\-\-no\-ff]
.P
.br
\fBgit\-psykorebase\fR \-\-continue
.SH "DESCRIPTION"
Rebase the \fBfeature_branch\fR on top of the \fBtarget_branch\fR, the \fBfeature_branch\fR defaults to the current one\.
Expand Down Expand Up @@ -35,12 +35,12 @@ $ git psykorebase \-\-continue
.fi
.IP "" 0
.SH "AUTHOR"
Written by Rémy Hubscher <\fI\%mailto:hubscher\.remy@gmail\.com\fR>
Written by Rémy Hubscher <\fIhubscher\.remy@gmail\.com\fR>
.P
Based on Benoît Bryon <\fI\%mailto:benoit@marmelune\.net\fR> implementation in Python\.
Based on Benoît Bryon <\fIbenoit@marmelune\.net\fR> implementation in Python\.
.SH "REPORTING BUGS"
<\fI\%https://github\.com/tj/git\-extras/issues\fR>
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.SH "SEE ALSO"
<\fI\%https://github\.com/tj/git\-extras\fR>
<\fIhttps://github\.com/tj/git\-extras\fR>
.P
<\fI\%https://github\.com/benoitbryon/psykorebase\fR>
<\fIhttps://github\.com/benoitbryon/psykorebase\fR>
Loading