All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: Ryan Anderson <ryan@michonline.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 3/3] request-pull: document -o/--output
Date: Sun,  3 Oct 2021 19:29:43 +0700	[thread overview]
Message-ID: <20211003122943.338199-4-bagasdotme@gmail.com> (raw)
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


      parent reply	other threads:[~2021-10-03 12:30 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-03 12:29 [PATCH 0/3] request-pull: write to file option Bagas Sanjaya
2021-10-03 12:29 ` [PATCH 1/3] request-pull: introduce display_message() function Bagas Sanjaya
2021-10-03 12:29 ` [PATCH 2/3] request-pull: add -o/--output option Bagas Sanjaya
2021-10-03 12:29 ` Bagas Sanjaya [this message]

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=20211003122943.338199-4-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=ryan@michonline.com \
    /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.