[PATCH v3 3/4] doc: dissuade users from trying to ignore tracked files
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Nov 2, 2019, 19:26 UTC
- Message-ID
- <20191102192615.10013-4-sandals@crustytoothpaste.net>
- In-Reply-To
- <20191102192615.10013-1-sandals@crustytoothpaste.net>
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 additon, 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: brian m. carlson <sandals@crustytoothpaste.net> --- Documentation/git-update-index.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 1c4d146a41..11230376c8 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -543,6 +543,22 @@ The untracked cache extension can be enabled by the `core.untrackedCache` configuration variable (see linkgit:git-config[1]). +NOTES +----- + +Users often try to use the ``assume unchanged'' and skip-worktree bits +to tell Git to ignore changes to files that are tracked. This does not +work as expected, since Git may still check working tree files against +the index when performing certain operations. In general, Git does not +provide a way to ignore changes to tracked files, so alternate solutions +are recommended. + +If the file you want to change is some sort of configuration file (say, +for a build tool, IDE, or editor), a common solution is to use a +templating mechanism, such as Ruby's ERB, to generate the ignored +configuration file from a template stored in the repository and a source +of data using a script or build step. + SEE ALSO -------- linkgit:git-config[1],