From: Junio C Hamano <gitster@pobox.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: <git@vger.kernel.org>, Derrick Stolee <dstolee@gmail.com>,
Thomas Gummerer <t.gummerer@gmail.com>
Subject: Re: [PATCH 6/6] doc: add stash export and import to docs
Date: Wed, 16 Mar 2022 10:34:09 -0700 [thread overview]
Message-ID: <xmqq35jhn6ni.fsf@gitster.g> (raw)
In-Reply-To: <20220310173236.4165310-7-sandals@crustytoothpaste.net> (brian m. carlson's message of "Thu, 10 Mar 2022 17:32:36 +0000")
"brian m. carlson" <sandals@crustytoothpaste.net> writes:
> Now that we have an easy way for users to import and export their
> stashes, let's document this in manual page so users will know how to
> use it.
>
> Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
> ---
> Documentation/git-stash.txt | 27 +++++++++++++++++++++++++++
> 1 file changed, 27 insertions(+)
>
> diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> index 6e15f47525..283677314a 100644
> --- a/Documentation/git-stash.txt
> +++ b/Documentation/git-stash.txt
> @@ -20,6 +20,8 @@ SYNOPSIS
> 'git stash' clear
> 'git stash' create [<message>]
> 'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
> +'git stash' export ( --print | --to-ref <ref> ) [<stashes>]
Again, "[<stash>...]", I think. Do we want SP inside () but no SP
inside []? That looks inconsistent.
I.e.
'git stash' export (--print|--to-ref <ref>) [<stash>...]
> +export ( --print | --to-ref <ref> ) [<stashes>]::
> +
> + Export the specified stashes, or all of them if none are specified, to
> + a chain of commits which can be transferred using the normal fetch and
> + push mechanisms, then imported using the `import` subcommand.
Ditto.
> +import <commit>::
> +
> + Import the specified stashes from the specified commit, which must have been
> + created by `export`, and add them to the list of stashes. To replace the
> + existing stashes, use `clear` first.
A tangent.
I personally prefer the style to have a blank line after the
"<dt>::" in asciidoc's way of doing description list used here, both
in these two new entries and many existing ones, by the way.
We probably should do that consistently, though.
> OPTIONS
> -------
> -a::
> @@ -239,6 +253,19 @@ literally (including newlines and quotes).
> +
> Quiet, suppress feedback messages.
>
> +--print::
> + This option is only valid for `export`.
> ++
> +Create the chain of commits representing the exported stashes without
> +storing it anywhere in the ref namespace and print the object ID to
> +standard output. This is designed for scripts.
> +
> +--to-ref::
> + This option is only valid for `export`.
> ++
> +Create the chain of commits representing the exported stashes and store
> +it to the specified ref.
> +
> \--::
> This option is only valid for `push` command.
> +
There is one more necessary update after this, no?
diff --git i/Documentation/git-stash.txt w/Documentation/git-stash.txt
index 283677314a..acce92b5d9 100644
--- i/Documentation/git-stash.txt
+++ w/Documentation/git-stash.txt
@@ -283,7 +283,7 @@ For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
<stash>::
This option is only valid for `apply`, `branch`, `drop`, `pop`,
- `show` commands.
+ `show`, and `export` commands.
+
A reference of the form `stash@{<revision>}`. When no `<stash>` is
given, the latest stash is assumed (that is, `stash@{0}`).
next prev parent reply other threads:[~2022-03-16 17:34 UTC|newest]
Thread overview: 76+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-10 17:32 [PATCH 0/6] Importing and exporting stashes to refs brian m. carlson
2022-03-10 17:32 ` [PATCH 1/6] builtin/stash: factor out generic function to look up stash info brian m. carlson
2022-03-10 17:32 ` [PATCH 2/6] builtin/stash: fill in all commit data brian m. carlson
2022-03-16 16:50 ` Junio C Hamano
2022-03-10 17:32 ` [PATCH 3/6] object-name: make get_oid quietly return an error brian m. carlson
2022-03-16 16:56 ` Junio C Hamano
2022-03-16 17:01 ` Drew Stolee
2022-03-16 21:40 ` brian m. carlson
2022-03-10 17:32 ` [PATCH 4/6] builtin/stash: provide a way to export stashes to a ref brian m. carlson
2022-03-11 2:08 ` Ævar Arnfjörð Bjarmason
2022-03-14 21:19 ` Phillip Wood
2022-03-15 10:50 ` Phillip Wood
2022-03-16 21:48 ` brian m. carlson
2022-03-18 13:34 ` C99 %zu support (on MSVC) (was: [PATCH 4/6] builtin/stash: provide a way to export stashes to a ref) Ævar Arnfjörð Bjarmason
2022-03-18 16:26 ` Phillip Wood
2022-03-24 14:02 ` [PATCH 4/6] builtin/stash: provide a way to export stashes to a ref Johannes Schindelin
2022-03-18 13:41 ` ssize_t portability (was: [PATCH 4/6] builtin/stash: provide a way to export stashes to a ref) Ævar Arnfjörð Bjarmason
2022-03-16 17:05 ` [PATCH 4/6] builtin/stash: provide a way to export stashes to a ref Junio C Hamano
2022-03-10 17:32 ` [PATCH 5/6] builtin/stash: provide a way to import stashes from " brian m. carlson
2022-03-16 17:26 ` Junio C Hamano
2022-03-16 21:50 ` brian m. carlson
2022-03-10 17:32 ` [PATCH 6/6] doc: add stash export and import to docs brian m. carlson
2022-03-16 17:34 ` Junio C Hamano [this message]
2022-03-16 21:44 ` Junio C Hamano
2022-03-10 19:14 ` [PATCH 0/6] Importing and exporting stashes to refs Junio C Hamano
2022-03-10 21:04 ` brian m. carlson
2022-03-10 21:38 ` Junio C Hamano
2022-03-10 22:42 ` brian m. carlson
2022-03-29 21:49 ` [PATCH v2 0/4] " brian m. carlson
2022-03-29 21:49 ` [PATCH v2 1/4] object-name: make get_oid quietly return an error brian m. carlson
2022-03-29 21:49 ` [PATCH v2 2/4] builtin/stash: factor out revision parsing into a function brian m. carlson
2022-03-29 21:49 ` [PATCH v2 3/4] builtin/stash: provide a way to export stashes to a ref brian m. carlson
2022-03-30 23:05 ` Junio C Hamano
2022-03-30 23:44 ` brian m. carlson
2022-03-31 1:56 ` Ævar Arnfjörð Bjarmason
2022-03-31 17:43 ` Junio C Hamano
2022-04-05 10:55 ` brian m. carlson
2022-04-06 9:05 ` Ævar Arnfjörð Bjarmason
2022-04-06 16:38 ` Junio C Hamano
2022-03-31 2:09 ` Ævar Arnfjörð Bjarmason
2022-04-05 10:22 ` brian m. carlson
2022-03-29 21:49 ` [PATCH v2 4/4] builtin/stash: provide a way to import stashes from " brian m. carlson
2022-03-31 1:48 ` [PATCH v2 0/4] Importing and exporting stashes to refs Junio C Hamano
2022-03-31 2:18 ` Ævar Arnfjörð Bjarmason
2022-04-03 18:22 ` [PATCH v3 " brian m. carlson
2022-04-03 18:22 ` [PATCH v3 1/4] object-name: make get_oid quietly return an error brian m. carlson
2022-04-03 18:22 ` [PATCH v3 2/4] builtin/stash: factor out revision parsing into a function brian m. carlson
2022-04-04 15:44 ` Phillip Wood
2022-04-03 18:22 ` [PATCH v3 3/4] builtin/stash: provide a way to export stashes to a ref brian m. carlson
2022-04-04 6:46 ` Ævar Arnfjörð Bjarmason
2022-04-03 18:22 ` [PATCH v3 4/4] builtin/stash: provide a way to import stashes from " brian m. carlson
2022-04-04 10:38 ` Ævar Arnfjörð Bjarmason
2022-04-05 10:03 ` brian m. carlson
2022-04-06 9:00 ` Ævar Arnfjörð Bjarmason
2022-04-04 0:05 ` [PATCH v3 0/4] Importing and exporting stashes to refs Junio C Hamano
2022-04-04 0:29 ` Junio C Hamano
2022-04-04 6:20 ` Ævar Arnfjörð Bjarmason
2022-04-05 9:15 ` brian m. carlson
2022-04-07 21:53 ` [PATCH v4 " brian m. carlson
2022-04-07 21:53 ` [PATCH v4 1/4] object-name: make get_oid quietly return an error brian m. carlson
2022-04-07 21:53 ` [PATCH v4 2/4] builtin/stash: factor out revision parsing into a function brian m. carlson
2022-04-07 21:53 ` [PATCH v4 3/4] builtin/stash: provide a way to export stashes to a ref brian m. carlson
2022-04-13 15:29 ` Ævar Arnfjörð Bjarmason
2022-04-13 15:36 ` Ævar Arnfjörð Bjarmason
2022-04-13 15:55 ` Ævar Arnfjörð Bjarmason
2022-04-07 21:53 ` [PATCH v4 4/4] builtin/stash: provide a way to import stashes from " brian m. carlson
2022-04-12 20:14 ` Jonathan Tan
2022-04-13 1:12 ` brian m. carlson
2022-04-13 17:34 ` Jonathan Tan
2022-04-13 18:25 ` Ævar Arnfjörð Bjarmason
2022-04-13 19:14 ` Jonathan Tan
2022-04-13 20:10 ` Junio C Hamano
2022-04-13 21:33 ` brian m. carlson
2022-04-13 21:43 ` Junio C Hamano
2022-04-13 18:33 ` Ævar Arnfjörð Bjarmason
2022-04-13 15:25 ` [PATCH v4 0/4] Importing and exporting stashes to refs Ævar Arnfjörð Bjarmason
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=xmqq35jhn6ni.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=dstolee@gmail.com \
--cc=git@vger.kernel.org \
--cc=sandals@crustytoothpaste.net \
--cc=t.gummerer@gmail.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).