From: Christoph Michelbach <michelbach94@gmail.com>
To: Philip Oakley <philipoakley@iee.org>,
Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH] Documentation/git-checkout: make doc. of checkout <tree-ish> clearer
Date: Mon, 17 Apr 2017 00:06:39 +0200 [thread overview]
Message-ID: <1492380399.19991.13.camel@gmail.com> (raw)
In-Reply-To: <DF5E72F5BD2F4BB99D8EC4DF1B4543F7@PhilipOakley>
On Sun, 2017-04-16 at 22:25 +0100, Philip Oakley wrote:
> From: "Christoph Michelbach" <michelbach94@gmail.com>
> > It's: git checkout [-p|--patch] [<tree-ish>] [--] <pathspec>...
> The one I quoted is direct from the Synopsis, which does indicate
> there are
> potentially more aspects to resolve, such as the influence of using
> the
> [-p|--patch] options.
Oh, you are right. I didn't even notice the one in the synopsis doesn't
match the one further down. The one in the synopsis is wrong because
after removing the optional parameters, it's the same as the first one
in the synopsis, yet we expect very different behavior from them.
> It maybe that the paragraph / sentence that needs adjusting is;
>
> 'git checkout' with <paths> or `--patch` is used to restore modified
> or
> deleted paths to their original contents from the index or replace
> paths
> with the contents from a named <tree-ish> (most often a commit-ish).
>
> and split it at the "or replace paths" option to pick out your
> specific
> case.
This one is confusing, too: Paths can lead to folders, yet folders whose
contents have been modified are not restored to their original contents
when executing that command. Only files are.
After reading the documentation and having never used the command
before, one would expect
#!/bin/bash
rm -Rf repo
mkdir repo
cd repo
git init &> /dev/null
mkdir folder
echo a > folder/a
git add -A
git commit -m "Commit 1." &> /dev/null
echo b > folder/b
git add -A
git commit -m "Commit 2." &> /dev/null
echo c > folder/c
git add -A
git commit -m "Commit 3." &> /dev/null
git checkout `git log --pretty=format:%H | tail -1` folder
ls folder
to print `a`. However, it prints `a b c` because all of the files inside
`folder` which have been modified or deleted since (here: none) are
reset to their original state after the first commit, but `folder`
itself isn't. Yet, the only path which was passed to the command in
question is `folder`.
In my opinion, this command needs improved documentation (and the
synopsis needs to be fixed).
--
Christoph
next prev parent reply other threads:[~2017-04-16 22:06 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-04-15 20:17 [PATCH] Documentation/git-checkout: make doc. of checkout <tree-ish> clearer Christoph Michelbach
2017-04-15 23:28 ` Philip Oakley
2017-04-16 13:01 ` Christoph Michelbach
2017-04-16 18:03 ` Philip Oakley
2017-04-16 18:51 ` Christoph Michelbach
2017-04-16 21:25 ` Philip Oakley
2017-04-16 22:06 ` Christoph Michelbach [this message]
2017-04-17 16:04 ` Philip Oakley
[not found] ` <1492452173.11708.22.camel@gmail.com>
2017-04-17 20:59 ` Philip Oakley
2017-04-18 0:31 ` Junio C Hamano
2017-04-18 12:26 ` Christoph Michelbach
2017-04-19 1:40 ` Junio C Hamano
2017-04-22 17:12 ` Christoph Michelbach
2017-04-24 1:55 ` Junio C Hamano
2017-04-24 12:24 ` Christoph Michelbach
2017-04-24 12:46 ` Christoph Michelbach
2017-04-25 1:35 ` Junio C Hamano
2017-04-25 9:11 ` Christoph Michelbach
2017-04-19 7:32 ` Philip Oakley
2017-04-18 11:50 ` Christoph Michelbach
2017-04-18 0:26 ` Junio C Hamano
2017-04-18 12:02 ` Christoph Michelbach
2017-04-19 8:14 ` Philip Oakley
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1492380399.19991.13.camel@gmail.com \
--to=michelbach94@gmail.com \
--cc=git@vger.kernel.org \
--cc=philipoakley@iee.org \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).