[PATCH 2/7] Documentation: clarify git-checkout -f, minor editing

Subsystems: documentation, the rest

STALE3708d

4 messages, 3 authors, 2016-06-15 · open the first message on its own page

[PATCH 2/7] Documentation: clarify git-checkout -f, minor editing

From: J. Bruce Fields <hidden>
Date: 2016-06-15 22:43:04

From: J. Bruce Fields <bfields@pad.(none)>

"Force a re-read of everything" doesn't mean much to me.

Also some minor grammar fixes.

Signed-off-by: "J. Bruce Fields" <redacted>
---
 Documentation/git-checkout.txt |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index f5b2d50..2ead493 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -23,9 +23,9 @@ options, which will be passed to `git branch`.
 
 When <paths> are given, this command does *not* switch
 branches.  It updates the named paths in the working tree from
-the index file (i.e. it runs `git-checkout-index -f -u`), or a
-named commit.  In
-this case, `-f` and `-b` options are meaningless and giving
+the index file (i.e. it runs `git-checkout-index -f -u`), or
+from a named commit.  In
+this case, the `-f` and `-b` options are meaningless and giving
 either of them results in an error.  <tree-ish> argument can be
 used to specify a specific tree-ish (i.e. commit, tag or tree)
 to update the index for the given paths before updating the
@@ -38,7 +38,8 @@ OPTIONS
 	Quiet, supress feedback messages.
 
 -f::
-	Force a re-read of everything.
+	Proceed even if the index or the working tree differs
+	from HEAD.
 
 -b::
 	Create a new branch named <new_branch> and start it at
-- 
1.5.1.1.98.gedb4f

Re: [PATCH 2/7] Documentation: clarify git-checkout -f, minor editing

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:43:04

"J. Bruce Fields" [off-list ref] writes:
quoted hunk
"Force a re-read of everything" doesn't mean much to me.
@@ -38,7 +38,8 @@ OPTIONS
 	Quiet, supress feedback messages.
 
 -f::
-	Force a re-read of everything.
+	Proceed even if the index or the working tree differs
+	from HEAD.
 
While this is definitely better, I think it still is not clear
why the command needs an option to proceed.

Not proceeding is about preventing local changes from getting
lost, and the option is a way to allow it to overwrite and lose
any local change.

Other than that, and your "From: " line (did you change your
config or switch machines?) on the first three commits, I find
all the changes very sensible.

Re: [PATCH 2/7] Documentation: clarify git-checkout -f, minor editing

From: J. Bruce Fields <hidden>
Date: 2016-06-15 22:43:05

On Sun, Apr 15, 2007 at 10:13:08PM -0700, Junio C Hamano wrote:
"J. Bruce Fields" [off-list ref] writes:
quoted
"Force a re-read of everything" doesn't mean much to me.
@@ -38,7 +38,8 @@ OPTIONS
 	Quiet, supress feedback messages.
 
 -f::
-	Force a re-read of everything.
+	Proceed even if the index or the working tree differs
+	from HEAD.
 
While this is definitely better, I think it still is not clear
why the command needs an option to proceed.

Not proceeding is about preventing local changes from getting
lost, and the option is a way to allow it to overwrite and lose
any local change.
OK, I agree; does the patch in the following message look like an
improvement?
Other than that, and your "From: " line (did you change your
config or switch machines?)
Whoops, yes, I was sloppy about setting up a new laptop--apologies.
on the first three commits, I find all the changes very sensible.
Thanks.--b.

[PATCH] git-commit.txt: better warning about -f option

From: J. Bruce Fields <hidden>
Date: 2016-06-15 22:43:05

Make sure the reader understands that -f may cause the loss of any local
changes.

Signed-off-by: "J. Bruce Fields" <redacted>
---
 Documentation/git-checkout.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 337b3d5..7aa877f 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -39,7 +39,7 @@ OPTIONS
 
 -f::
 	Proceed even if the index or the working tree differs
-	from HEAD.
+	from HEAD, possibly overwriting and losing any local changes.
 
 -b::
 	Create a new branch named <new_branch> and start it at
-- 
1.5.1.1.98.gedb4f
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help