threads / patch / 59697

patchdoc: restore: remove note on --patch w/ pathspecs

Subject: [PATCH] doc: restore: remove note on --patch w/ pathspecs

## tl;dr

6 messages between May 5, 2023 and Mar 17, 2025. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Adam Johnson via GitGitGadget· May 5, 2023, 10:32 UTC · lore
From: Adam Johnson <me@adamj.eu>

This note was added with the command in 46e91b663b (checkout: split part of it to new command 'restore', 2019-04-25), but it is now inaccurate. The underlying builtin `add -i` implementation, made default in 0527ccb1b5 (add -i: default to the built-in implementation, 2021-11-30), supports pathspecs, so `git restore -p <pathspec>...` has worked for all users since then. I bisected to verify this was the commit that added support.

Signed-off-by: Adam Johnson <me@adamj.eu>
---
    doc: restore: remove note on --patch w/ pathspecs
    
    This note was added with the command in 46e91b663b, but it is now
    inaccurate. The underlying builtin add -i implementation, made default
    in 0527ccb1b5, does support pathspecs, so git restore -p <pathspec>...
    has worked for all users since then. I bisected to verify this.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1504%2Fadamchainz%2Faj%2Fgit-restore-patch-docs-fix-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v1
Pull-Request: https://github.com/git/git/pull/1504
 Documentation/git-restore.txt | 3 ---
 1 file changed, 3 deletions(-)
Show changes to Documentation/git-restore.txt +0 −3
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 5964810caa4..d31a06a673e 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -51,9 +51,6 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
 	restore source and the restore location. See the ``Interactive
 	Mode'' section of linkgit:git-add[1] to learn how to operate
 	the `--patch` mode.
-+
-Note that `--patch` can accept no pathspec and will prompt to restore
-all modified paths.
 
 -W::
 --worktree::

base-commit: f285f68a132109c234d93490671c00218066ace9
-- 
gitgitgadget
Adam Johnson· May 25, 2023, 07:25 UTC · re: Adam Johnson via GitGitGadget · lore

Re: [PATCH] doc: restore: remove note on --patch w/ pathspecs

Hi, is there anything I can do to help with review?

On Fri, May 5, 2023 at 11:32 AM Adam Johnson via GitGitGadget <gitgitgadget@gmail.com> wrote:

Show 44 quoted lines
>
> From: Adam Johnson <me@adamj.eu>
>
> This note was added with the command in 46e91b663b (checkout: split part of
> it to new command 'restore', 2019-04-25), but it is now inaccurate. The
> underlying builtin `add -i` implementation, made default in 0527ccb1b5 (add
> -i: default to the built-in implementation, 2021-11-30), supports pathspecs,
> so `git restore -p <pathspec>...` has worked for all users since then. I
> bisected to verify this was the commit that added support.
>
> Signed-off-by: Adam Johnson <me@adamj.eu>
> ---
>     doc: restore: remove note on --patch w/ pathspecs
>
>     This note was added with the command in 46e91b663b, but it is now
>     inaccurate. The underlying builtin add -i implementation, made default
>     in 0527ccb1b5, does support pathspecs, so git restore -p <pathspec>...
>     has worked for all users since then. I bisected to verify this.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1504%2Fadamchainz%2Faj%2Fgit-restore-patch-docs-fix-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v1
> Pull-Request: https://github.com/git/git/pull/1504
>
>  Documentation/git-restore.txt | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
> index 5964810caa4..d31a06a673e 100644
> --- a/Documentation/git-restore.txt
> +++ b/Documentation/git-restore.txt
> @@ -51,9 +51,6 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
>         restore source and the restore location. See the ``Interactive
>         Mode'' section of linkgit:git-add[1] to learn how to operate
>         the `--patch` mode.
> -+
> -Note that `--patch` can accept no pathspec and will prompt to restore
> -all modified paths.
>
>  -W::
>  --worktree::
>
> base-commit: f285f68a132109c234d93490671c00218066ace9
> --
> gitgitgadget
Junio C Hamano· Jun 1, 2023, 05:09 UTC · re: Adam Johnson · lore

Re: [PATCH] doc: restore: remove note on --patch w/ pathspecs

Adam Johnson <me@adamj.eu> writes:
> Hi, is there anything I can do to help with review?
One good thing you can do is to ping like you did ;-)

I have been down/sick and will be a bit busy with release work but after that I may find time to review it myself, as it sounds like an easy change. But I'll comment on something I immediately spotted.

Show 7 quoted lines
>
> On Fri, May 5, 2023 at 11:32 AM Adam Johnson via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>>
>> From: Adam Johnson <me@adamj.eu>
>>
>> This note was added with the command in 46e91b663b (checkout: split part of
"command" -> "commit", I think.
Adam Johnson via GitGitGadget· Jun 1, 2023, 21:14 UTC · re: Adam Johnson via GitGitGadget · lore

[PATCH v2] doc: restore: remove note on --patch w/ pathspecs

From: Adam Johnson <me@adamj.eu>

This note was added with the restore command docs in 46e91b663b (checkout: split part of it to new command 'restore', 2019-04-25), but it is now inaccurate. The underlying builtin `add -i` implementation, made default in 0527ccb1b5 (add -i: default to the built-in implementation, 2021-11-30), supports pathspecs, so `git restore -p <pathspec>...` has worked for all users since then. I bisected to verify this was the commit that added support.

Signed-off-by: Adam Johnson <me@adamj.eu>
---
    doc: restore: remove note on --patch w/ pathspecs
    
    This note was added with the command in 46e91b663b, but it is now
    inaccurate. The underlying builtin add -i implementation, made default
    in 0527ccb1b5, does support pathspecs, so git restore -p <pathspec>...
    has worked for all users since then. I bisected to verify this.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1504%2Fadamchainz%2Faj%2Fgit-restore-patch-docs-fix-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v2
Pull-Request: https://github.com/git/git/pull/1504
Range-diff vs v1:
 1:  784143b9949 ! 1:  556f4323ce6 doc: restore: remove note on --patch w/ pathspecs
     @@ Metadata
       ## Commit message ##
          doc: restore: remove note on --patch w/ pathspecs
      
     -    This note was added with the command in 46e91b663b (checkout: split part of
     -    it to new command 'restore', 2019-04-25), but it is now inaccurate. The
     -    underlying builtin `add -i` implementation, made default in 0527ccb1b5 (add
     -    -i: default to the built-in implementation, 2021-11-30), supports pathspecs,
     -    so `git restore -p <pathspec>...` has worked for all users since then. I
     -    bisected to verify this was the commit that added support.
     +    This note was added with the restore command docs in 46e91b663b
     +    (checkout: split part of it to new command 'restore', 2019-04-25), but it is
     +    now inaccurate. The underlying builtin `add -i` implementation, made default
     +    in 0527ccb1b5 (add -i: default to the built-in implementation, 2021-11-30),
     +    supports pathspecs, so `git restore -p <pathspec>...` has worked for all
     +    users since then. I bisected to verify this was the commit that added
     +    support.
      
          Signed-off-by: Adam Johnson <me@adamj.eu>
      
 Documentation/git-restore.txt | 3 ---
 1 file changed, 3 deletions(-)
Show changes to Documentation/git-restore.txt +0 −3
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 5964810caa4..d31a06a673e 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -51,9 +51,6 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
 	restore source and the restore location. See the ``Interactive
 	Mode'' section of linkgit:git-add[1] to learn how to operate
 	the `--patch` mode.
-+
-Note that `--patch` can accept no pathspec and will prompt to restore
-all modified paths.
 
 -W::
 --worktree::

base-commit: f285f68a132109c234d93490671c00218066ace9
-- 
gitgitgadget
Johannes Schindelin· Mar 16, 2025, 00:47 UTC · re: Adam Johnson via GitGitGadget · lore

Re: [PATCH v2] doc: restore: remove note on --patch w/ pathspecs

Hi Adam,
On Thu, 1 Jun 2023, Adam Johnson via GitGitGadget wrote:
Show 45 quoted lines
> From: Adam Johnson <me@adamj.eu>
>
> This note was added with the restore command docs in 46e91b663b
> (checkout: split part of it to new command 'restore', 2019-04-25), but it is
> now inaccurate. The underlying builtin `add -i` implementation, made default
> in 0527ccb1b5 (add -i: default to the built-in implementation, 2021-11-30),
> supports pathspecs, so `git restore -p <pathspec>...` has worked for all
> users since then. I bisected to verify this was the commit that added
> support.
>
> Signed-off-by: Adam Johnson <me@adamj.eu>
> ---
>     doc: restore: remove note on --patch w/ pathspecs
>
>     This note was added with the command in 46e91b663b, but it is now
>     inaccurate. The underlying builtin add -i implementation, made default
>     in 0527ccb1b5, does support pathspecs, so git restore -p <pathspec>...
>     has worked for all users since then. I bisected to verify this.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1504%2Fadamchainz%2Faj%2Fgit-restore-patch-docs-fix-v2
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v2
> Pull-Request: https://github.com/git/git/pull/1504
>
> Range-diff vs v1:
>
>  1:  784143b9949 ! 1:  556f4323ce6 doc: restore: remove note on --patch w/ pathspecs
>      @@ Metadata
>        ## Commit message ##
>           doc: restore: remove note on --patch w/ pathspecs
>
>      -    This note was added with the command in 46e91b663b (checkout: split part of
>      -    it to new command 'restore', 2019-04-25), but it is now inaccurate. The
>      -    underlying builtin `add -i` implementation, made default in 0527ccb1b5 (add
>      -    -i: default to the built-in implementation, 2021-11-30), supports pathspecs,
>      -    so `git restore -p <pathspec>...` has worked for all users since then. I
>      -    bisected to verify this was the commit that added support.
>      +    This note was added with the restore command docs in 46e91b663b
>      +    (checkout: split part of it to new command 'restore', 2019-04-25), but it is
>      +    now inaccurate. The underlying builtin `add -i` implementation, made default
>      +    in 0527ccb1b5 (add -i: default to the built-in implementation, 2021-11-30),
>      +    supports pathspecs, so `git restore -p <pathspec>...` has worked for all
>      +    users since then. I bisected to verify this was the commit that added
>      +    support.
>
>           Signed-off-by: Adam Johnson <me@adamj.eu>

You clearly have addressed Junio's concern, and since the reasoning in the commit message is valid and the diff is trivially correct, this patch should be good to go.

Ciao, Johannes

Show 25 quoted lines
>
>
>
>  Documentation/git-restore.txt | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
> index 5964810caa4..d31a06a673e 100644
> --- a/Documentation/git-restore.txt
> +++ b/Documentation/git-restore.txt
> @@ -51,9 +51,6 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
>  	restore source and the restore location. See the ``Interactive
>  	Mode'' section of linkgit:git-add[1] to learn how to operate
>  	the `--patch` mode.
> -+
> -Note that `--patch` can accept no pathspec and will prompt to restore
> -all modified paths.
>
>  -W::
>  --worktree::
>
> base-commit: f285f68a132109c234d93490671c00218066ace9
> --
> gitgitgadget
>
Junio C Hamano· Mar 17, 2025, 22:11 UTC · re: Johannes Schindelin · lore

Re: [PATCH v2] doc: restore: remove note on --patch w/ pathspecs

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:
Show 7 quoted lines
> Hi Adam,
> ...
> commit message is valid and the diff is trivially correct, this patch
> should be good to go.
>
> Ciao,
> Johannes
Thanks, both.  Will queue.

← back to recent threads