git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 3/3] request-pull: document -o/--output

From
Bagas Sanjaya <bagasdotme@gmail.com>
Date
Oct 3, 2021, 12:29 UTC
Message-ID
<20211003122943.338199-4-bagasdotme@gmail.com>
In-Reply-To
<20211003122943.338199-1-bagasdotme@gmail.com>

Document the option in git-request-pull(1), as well as usage example (along with shell redirection method).

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/git-request-pull.txt | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt
index 4d4392d0f8..4bb07d8865 100644
--- a/Documentation/git-request-pull.txt
+++ b/Documentation/git-request-pull.txt
@@ -8,7 +8,7 @@ git-request-pull - Generates a summary of pending changes
 SYNOPSIS
 --------
 [verse]
-'git request-pull' [-p] <start> <url> [<end>]
+'git request-pull' [-p] [-o | --output <file>] <start> <url> [<end>]
 
 DESCRIPTION
 -----------
@@ -29,6 +29,10 @@ OPTIONS
 -p::
 	Include patch text in the output.
 
+-o <file>::
+--output <file>::
+	Write the request to the specified file.
+
 <start>::
 	Commit to start at.  This names a commit that is already in
 	the upstream history.
@@ -64,6 +68,15 @@ which will produce a request to the upstream, summarizing the
 changes between the `v1.0` release and your `master`, to pull it
 from your public repository.
 
+To generate the request to a file for later editing, you can either
+use shell redirection:
+
+	git request-pull v1.0 https://git.ko.xz/project master > request
+
+or with `-o` option:
+
+	git request-pull -o request v1.0 https://git.ko.xz/project master
+
 If you pushed your change to a branch whose name is different from
 the one you have locally, e.g.
 
@@ -73,7 +86,6 @@ then you can ask that to be pulled with
 
 	git request-pull v1.0 https://git.ko.xz/project master:for-linus
 
-
 GIT
 ---
 Part of the linkgit:git[1] suite
-- 
An old man doll... just what I always wanted! - Clara
Previous: Bagas Sanjaya
Message 4 of 4 in “request-pull: write to file option”
  1. 0/3 request-pull: write to file optionBagas Sanjaya, Oct 3, 2021
  2. 2/3 request-pull: add -o/--output optionBagas Sanjaya, Oct 3, 2021
  3. 1/3 request-pull: introduce display_message() functionBagas Sanjaya, Oct 3, 2021
  4. 3/3 request-pull: document -o/--outputBagas Sanjaya, Oct 3, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.