Skip to content

Commit f5db762

Browse files
jnavilagitster
authored andcommitted
doc: convert git-request-pull synopsis and options to new style
* Replace [verse] with [synopsis] in the SYNOPSIS block * remove single-quote formatting from the command name * backtick-quote the flag * use _<placeholder>_ form for positional parameter terms Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 1d4aeb8 commit f5db762

1 file changed

Lines changed: 23 additions & 15 deletions

File tree

Documentation/git-request-pull.adoc

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ git-request-pull - Generates a summary of pending changes
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git request-pull' [-p] <start> <URL> [<end>]
10+
[synopsis]
11+
git request-pull [-p] <start> <URL> [<end>]
1212

1313
DESCRIPTION
1414
-----------
@@ -19,28 +19,28 @@ begins with the branch description, summarizes
1919
the changes, and indicates from where they can be pulled.
2020

2121
The upstream project is expected to have the commit named by
22-
`<start>` and the output asks it to integrate the changes you made
23-
since that commit, up to the commit named by `<end>`, by visiting
24-
the repository named by `<URL>`.
22+
_<start>_ and the output asks it to integrate the changes you made
23+
since that commit, up to the commit named by _<end>_, by visiting
24+
the repository named by _<URL>_.
2525

2626

2727
OPTIONS
2828
-------
29-
-p::
29+
`-p`::
3030
Include patch text in the output.
3131

32-
<start>::
32+
_<start>_::
3333
Commit to start at. This names a commit that is already in
3434
the upstream history.
3535

36-
<URL>::
36+
_<URL>_::
3737
The repository URL to be pulled from.
3838

39-
<end>::
40-
Commit to end at (defaults to HEAD). This names the commit
39+
_<end>_::
40+
Commit to end at (defaults to `HEAD`). This names the commit
4141
at the tip of the history you are asking to be pulled.
4242
+
43-
When the repository named by `<URL>` has the commit at a tip of a
43+
When the repository named by _<URL>_ has the commit at a tip of a
4444
ref that is different from the ref you have locally, you can use the
4545
`<local>:<remote>` syntax, to have its local name, a colon `:`, and
4646
its remote name.
@@ -54,11 +54,15 @@ the `v1.0` release, and want it to be integrated into the project.
5454
First you push that change to your public repository for others to
5555
see:
5656

57-
git push https://git.ko.xz/project master
57+
-----
58+
git push https://git.ko.xz/project master
59+
-----
5860

5961
Then, you run this command:
6062

61-
git request-pull v1.0 https://git.ko.xz/project master
63+
------
64+
git request-pull v1.0 https://git.ko.xz/project master
65+
------
6266

6367
which will produce a request to the upstream, summarizing the
6468
changes between the `v1.0` release and your `master`, to pull it
@@ -67,11 +71,15 @@ from your public repository.
6771
If you pushed your change to a branch whose name is different from
6872
the one you have locally, e.g.
6973

70-
git push https://git.ko.xz/project master:for-linus
74+
-----
75+
git push https://git.ko.xz/project master:for-linus
76+
-----
7177

7278
then you can ask that to be pulled with
7379

74-
git request-pull v1.0 https://git.ko.xz/project master:for-linus
80+
-----
81+
git request-pull v1.0 https://git.ko.xz/project master:for-linus
82+
-----
7583

7684

7785
GIT

0 commit comments

Comments
 (0)