opendev/git-restack
Code Issues Proposed changes

Fix groff warnings with manpage

Browse Source 
Previous addition of backslashes '\' to escape hypens '-' also escaped
options to the mdoc formatting commands by accident.

Change-Id: I327ccb8a84fb199362e6a5dd7c5f5bff3d5b2bb4
This commit is contained in:
Darragh Bailey
2014-07-18 21:38:49 +01:00
parent ada3d9102a
commit 648182a410
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
git-review.1
View File

@@ -63,7 +63,7 @@ for fetching exact patchset from the change.
In that case local branch name will have a \-patch[patchsetNumber] suffix. In that case local branch name will have a \-patch[patchsetNumber] suffix.
.Pp .Pp
The following options are available: The following options are available:
.Bl \-tag \-width indent .Bl -tag -width indent
.It Fl d Ar change , Fl \-download= Ns Ar change .It Fl d Ar change , Fl \-download= Ns Ar change
Download Download
.Ar change .Ar change
@@ -165,7 +165,7 @@ Print the version number and exit.
This utility can be configured by adding entries to Git configuration. This utility can be configured by adding entries to Git configuration.
.Pp .Pp
The following configuration keys are supported: The following configuration keys are supported:
.Bl \-tag .Bl -tag
.It gitreview.username .It gitreview.username
Default username used to access the repository. If not specified Default username used to access the repository. If not specified
in the Git configuration, Git remote or in the Git configuration, Git remote or
@@ -175,7 +175,7 @@ file, the user will be prompted to specify the username.
Example entry in the Example entry in the
.Pa .gitconfig .Pa .gitconfig
file: file:
.Bd \-literal \-offset indent .Bd -literal -offset indent
[gitreview] [gitreview]
username=\fImygerrituser\fP username=\fImygerrituser\fP
.Ed .Ed
@@ -184,7 +184,7 @@ This setting determines whether changes submitted will
be rebased to the newest state of the branch. be rebased to the newest state of the branch.
.Pp .Pp
A value of 'true' or 'false' should be specified. A value of 'true' or 'false' should be specified.
.Bl \-tag .Bl -tag
.It false .It false
Do not rebase changes on submit \- equivalent to setting Do not rebase changes on submit \- equivalent to setting
.Fl R .Fl R
@@ -208,7 +208,7 @@ with your project, it is recommended that you create
a file at the root of the repository named a file at the root of the repository named
.Pa .gitreview .Pa .gitreview
and place information about your gerrit installation in it. The format is similar to the Windows .ini file format: and place information about your gerrit installation in it. The format is similar to the Windows .ini file format:
.Bd \-literal \-offset indent .Bd -literal -offset indent
[gerrit] [gerrit]
host=\fIhostname\fP host=\fIhostname\fP
port=\fITCP port number of gerrit\fP port=\fITCP port number of gerrit\fP
@@ -228,7 +228,7 @@ to zero will make
not to rebase changes by default (same as the not to rebase changes by default (same as the
.Fl R .Fl R
command line option) command line option)
.Bd \-literal \-offset indent .Bd -literal -offset indent
[gerrit] [gerrit]
host=review.example.com host=review.example.com
port=29418 port=29418
@@ -243,7 +243,7 @@ defaultrebase=0
Normally, exit status is 0 if executed successfully. Normally, exit status is 0 if executed successfully.
Exit status 1 indicates general error, sometimes more Exit status 1 indicates general error, sometimes more
specific error codes are available: specific error codes are available:
.Bl \-tag \-width 999 .Bl -tag -width 999
.It 2 .It 2
Gerrit Gerrit
.Ar commit\-msg .Ar commit\-msg
@@ -289,14 +289,14 @@ Exit status larger than 31 indicates problem with
communication with Gerrit or remote Git repository, communication with Gerrit or remote Git repository,
exit status larger than 63 means there was a problem with exit status larger than 63 means there was a problem with
a local repository or a working copy. a local repository or a working copy.
.Pp
Exit status larger than or equal to 128 means internal Exit status larger than or equal to 128 means internal
error in running the "git" command. error in running the "git" command.
.Pp .Pp
.Sh EXAMPLES .Sh EXAMPLES
To fetch a remote change number 3004: To fetch a remote change number 3004:
.Pp .Pp
.Bd \-literal \-offset indent .Bd -literal -offset indent
$ git\-review \-d 3004 $ git\-review \-d 3004
Downloading refs/changes/04/3004/1 from gerrit into Downloading refs/changes/04/3004/1 from gerrit into
review/someone/topic_name review/someone/topic_name
@@ -311,7 +311,7 @@ to name a local branch. This facilitates easier identification of changes.
.Pp .Pp
To fetch a remote patchset number 5 from change number 3004: To fetch a remote patchset number 5 from change number 3004:
.Pp .Pp
.Bd \-literal \-offset indent .Bd -literal -offset indent
$ git\-review \-d 3004,5 $ git\-review \-d 3004,5
Downloading refs/changes/04/3004/5 from gerrit into Downloading refs/changes/04/3004/5 from gerrit into
review/someone/topic_name\-patch5 review/someone/topic_name\-patch5
@@ -322,7 +322,7 @@ $ git branch
.Ed .Ed
.Pp .Pp
To send a change for review and delete local branch afterwards: To send a change for review and delete local branch afterwards:
.Bd \-literal \-offset indent .Bd -literal -offset indent
$ git\-review \-f $ git\-review \-f
remote: Resolving deltas: 0% (0/8) remote: Resolving deltas: 0% (0/8)
To ssh://username@review.example.com/departement/project.git To ssh://username@review.example.com/departement/project.git
@@ -344,7 +344,7 @@ port
in the branch in the branch
.Cm master .Cm master
: :
.Bd \-literal \-offset indent .Bd -literal -offset indent
[gerrit] [gerrit]
host=review.example.com host=review.example.com
port=29418 port=29418