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>
Jean-Noël Avila committed
Jul 23, 2026 at 21:19 UTC
f8c6bb65d779f0e4eb065acdef76a496a163f4b4
1 file changed
+23
-15
Documentation/git-request-pull.adoc
+23
-15
@@ -7,8 +7,8 @@ git-request-pull - Generates a summary of pending changes
7
8
SYNOPSIS
9
--------
10
-[verse]
11
-'git request-pull' [-p] <start> <URL> [<end>]
10
+[synopsis]
11
+git request-pull [-p] <start> <URL> [<end>]
12
13
DESCRIPTION
14
-----------
@@ -19,28 +19,28 @@ begins with the branch description, summarizes
19
the changes, and indicates from where they can be pulled.
20
21
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>_.
25
26
27
OPTIONS
28
-------
29
--p::
29
+`-p`::
30
Include patch text in the output.
31
32
-<start>::
32
+_<start>_::
33
Commit to start at. This names a commit that is already in
34
the upstream history.
35
36
-<URL>::
36
+_<URL>_::
37
The repository URL to be pulled from.
38
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
41
at the tip of the history you are asking to be pulled.
42
+
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
44
ref that is different from the ref you have locally, you can use the
45
`<local>:<remote>` syntax, to have its local name, a colon `:`, and
46
its remote name.
@@ -54,11 +54,15 @@ the `v1.0` release, and want it to be integrated into the project.
54
First you push that change to your public repository for others to
55
see:
56
57
- git push https://git.ko.xz/project master
57
+----
58
+git push https://git.ko.xz/project master
59
+----
60
61
Then, you run this command:
62
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
+----
66
67
which will produce a request to the upstream, summarizing the
68
changes between the `v1.0` release and your `master`, to pull it
@@ -67,11 +71,15 @@ from your public repository.
71
If you pushed your change to a branch whose name is different from
72
the one you have locally, e.g.
73
70
- git push https://git.ko.xz/project master:for-linus
74
+----
75
+git push https://git.ko.xz/project master:for-linus
76
+----
77
78
then you can ask that to be pulled with
79
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
+----
83
84
85
GIT