diff mbox series

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

Message ID 20211003122943.338199-4-bagasdotme@gmail.com (mailing list archive)
State New, archived
Headers show
Series request-pull: write to file option | expand

Commit Message

Bagas Sanjaya Oct. 3, 2021, 12:29 p.m. UTC 
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 mbox series

Patch

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