From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 4/4] doc: convert git-request-pull synopsis and options to new style
Date: Sun, 19 Jul 2026 19:54:37 +0000 [thread overview]
Message-ID: <5b6e9bd3f3569cf9977d1cfd120a92756ec86b29.1784490878.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.2185.git.1784490878.gitgitgadget@gmail.com>
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
* 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>
---
Documentation/git-request-pull.adoc | 38 +++++++++++++++++------------
1 file changed, 23 insertions(+), 15 deletions(-)
diff --git a/Documentation/git-request-pull.adoc b/Documentation/git-request-pull.adoc
index 15dcbb6d91..8b6642b312 100644
--- a/Documentation/git-request-pull.adoc
+++ b/Documentation/git-request-pull.adoc
@@ -7,8 +7,8 @@ git-request-pull - Generates a summary of pending changes
SYNOPSIS
--------
-[verse]
-'git request-pull' [-p] <start> <URL> [<end>]
+[synopsis]
+git request-pull [-p] <start> <URL> [<end>]
DESCRIPTION
-----------
@@ -19,28 +19,28 @@ begins with the branch description, summarizes
the changes, and indicates from where they can be pulled.
The upstream project is expected to have the commit named by
-`<start>` and the output asks it to integrate the changes you made
-since that commit, up to the commit named by `<end>`, by visiting
-the repository named by `<URL>`.
+_<start>_ and the output asks it to integrate the changes you made
+since that commit, up to the commit named by _<end>_, by visiting
+the repository named by _<URL>_.
OPTIONS
-------
--p::
+`-p`::
Include patch text in the output.
-<start>::
+_<start>_::
Commit to start at. This names a commit that is already in
the upstream history.
-<URL>::
+_<URL>_::
The repository URL to be pulled from.
-<end>::
- Commit to end at (defaults to HEAD). This names the commit
+_<end>_::
+ Commit to end at (defaults to `HEAD`). This names the commit
at the tip of the history you are asking to be pulled.
+
-When the repository named by `<URL>` has the commit at a tip of a
+When the repository named by _<URL>_ has the commit at a tip of a
ref that is different from the ref you have locally, you can use the
`<local>:<remote>` syntax, to have its local name, a colon `:`, and
its remote name.
@@ -54,11 +54,15 @@ the `v1.0` release, and want it to be integrated into the project.
First you push that change to your public repository for others to
see:
- git push https://git.ko.xz/project master
+-----
+git push https://git.ko.xz/project master
+-----
Then, you run this command:
- git request-pull v1.0 https://git.ko.xz/project master
+------
+git request-pull v1.0 https://git.ko.xz/project master
+------
which will produce a request to the upstream, summarizing the
changes between the `v1.0` release and your `master`, to pull it
@@ -67,11 +71,15 @@ from your public repository.
If you pushed your change to a branch whose name is different from
the one you have locally, e.g.
- git push https://git.ko.xz/project master:for-linus
+-----
+git push https://git.ko.xz/project master:for-linus
+-----
then you can ask that to be pulled with
- git request-pull v1.0 https://git.ko.xz/project master:for-linus
+-----
+git request-pull v1.0 https://git.ko.xz/project master:for-linus
+-----
GIT
--
gitgitgadget
next prev parent reply other threads:[~2026-07-19 19:54 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-19 19:54 [PATCH 0/4] A new batch of synopsis conversion Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` [PATCH 1/4] doc: convert git-imap-send synopsis and options to new style Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` [PATCH 2/4] doc: convert git-format-patch " Jean-Noël Avila via GitGitGadget
2026-07-19 23:40 ` Junio C Hamano
2026-07-20 20:09 ` Jean-Noël AVILA
2026-07-19 19:54 ` [PATCH 3/4] doc: convert git-send-email " Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` Jean-Noël Avila via GitGitGadget [this message]
2026-07-19 23:47 ` [PATCH 4/4] doc: convert git-request-pull " Junio C Hamano
2026-07-20 20:39 ` Jean-Noël AVILA
2026-07-20 21:26 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5b6e9bd3f3569cf9977d1cfd120a92756ec86b29.1784490878.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=jn.avila@free.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.