Skip to content

Commit

Permalink
Documentation: call out commands that nuke untracked files/directories
Browse files Browse the repository at this point in the history
Some commands have traditionally also removed untracked files (or
directories) that were in the way of a tracked file we needed.  Document
these cases.

Signed-off-by: Elijah Newren <newren@gmail.com>
  • Loading branch information
newren committed Sep 23, 2021
1 parent 4b78a52 commit 993451a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
5 changes: 3 additions & 2 deletions Documentation/git-checkout.txt
Expand Up @@ -118,8 +118,9 @@ OPTIONS
-f::
--force::
When switching branches, proceed even if the index or the
working tree differs from `HEAD`. This is used to throw away
local changes.
working tree differs from `HEAD`, and even if there are untracked
files in the way. This is used to throw away local changes and
any untracked files or directories that are in the way.
+
When checking out paths from the index, do not fail upon unmerged
entries; instead, unmerged entries are ignored.
Expand Down
5 changes: 3 additions & 2 deletions Documentation/git-read-tree.txt
Expand Up @@ -39,8 +39,9 @@ OPTIONS

--reset::
Same as -m, except that unmerged entries are discarded instead
of failing. When used with `-u`, updates leading to loss of
working tree changes will not abort the operation.
of failing. When used with `-u`, updates leading to loss of
working tree changes or untracked files or directories will not
abort the operation.

-u::
After a successful merge, update the files in the work
Expand Down
3 changes: 2 additions & 1 deletion Documentation/git-reset.txt
Expand Up @@ -69,7 +69,8 @@ linkgit:git-add[1]).

--hard::
Resets the index and working tree. Any changes to tracked files in the
working tree since `<commit>` are discarded.
working tree since `<commit>` are discarded. Any untracked files or
directories in the way of writing any tracked files are simply deleted.

--merge::
Resets the index and updates the files in the working tree that are
Expand Down

0 comments on commit 993451a

Please sign in to comment.