Skip to content

Conversation

adamchainz
Copy link
Contributor

This note was added with the command in 46e91b6, but it is now inaccurate. The underlying builtin add -i implementation, made default in 0527ccb, does support pathspecs, so git restore -p <pathspec>... has worked for all users since then. I bisected to verify this.

CC: Johannes Schindelin Johannes.Schindelin@gmx.de, Junio C Hamano gitster@pobox.com

@gitgitgadget-git
Copy link

There are issues in commit b2ab99d:
doc: restore: remove note on --patch w/ pathspecs
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

@adamchainz adamchainz force-pushed the aj/git-restore-patch-docs-fix branch from b2ab99d to 784143b Compare May 5, 2023 09:10
@adamchainz
Copy link
Contributor Author

/submit

@gitgitgadget-git
Copy link

Submitted as pull.1504.git.git.1683282753768.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v1

To fetch this version to local tag pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v1

@Kushy420

This comment was marked as off-topic.

@gitgitgadget-git
Copy link

On the Git mailing list, Adam Johnson wrote (reply to this):

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:
>
> 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

@gitgitgadget-git
Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

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.

>
> 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.

This note was added with the restore command docs in 46e91b6
(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 0527ccb (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>
@adamchainz adamchainz force-pushed the aj/git-restore-patch-docs-fix branch from 784143b to 556f432 Compare June 1, 2023 21:13
@adamchainz
Copy link
Contributor Author

/submit

@gitgitgadget-git
Copy link

Submitted as pull.1504.v2.git.git.1685654097812.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v2

To fetch this version to local tag pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v2:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1504/adamchainz/aj/git-restore-patch-docs-fix-v2

Copy link

On the Git mailing list, Johannes Schindelin wrote (reply to this):

Hi Adam,

On Thu, 1 Jun 2023, Adam Johnson via GitGitGadget wrote:

> 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

>
>
>
>  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
>

Copy link

On the Git mailing list, Junio C Hamano wrote (reply to this):

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:

> 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants