]> git.ipfire.org Git - thirdparty/git.git/commit
doc: dissuade users from trying to ignore tracked files
authorbrian m. carlson <sandals@crustytoothpaste.net>
Wed, 22 Jan 2020 03:45:42 +0000 (03:45 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Jan 2020 20:27:49 +0000 (12:27 -0800)
commit1b13e9032f039c8cdb1994dd092ff2ed32af5cf5
tree8750bc77ac4100ecef1c21a3d2a6c0e918c3e44d
parent232378479ee6c66206d47a9be175e3a39682aea6
doc: dissuade users from trying to ignore tracked files

It is quite common for users to want to ignore the changes to a file
that Git tracks.  Common scenarios for this case are IDE settings and
configuration files, which should generally not be tracked and possibly
generated from tracked files using a templating mechanism.

However, users learn about the assume-unchanged and skip-worktree bits
and try to use them to do this anyway.  This is problematic, because
when these bits are set, many operations behave as the user expects, but
they usually do not help when git checkout needs to replace a file.

There is no sensible behavior in this case, because sometimes the data
is precious, such as certain configuration files, and sometimes it is
irrelevant data that the user would be happy to discard.

Since this is not a supported configuration and users are prone to
misuse the existing features for unintended purposes, causing general
sadness and confusion, let's document the existing behavior and the
pitfalls in the documentation for git update-index so that users know
they should explore alternate solutions.

In addition, let's provide a recommended solution to dealing with the
common case of configuration files, since there are well-known
approaches used successfully in many environments.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-update-index.txt