diff options
| author | brian m. carlson <sandals@crustytoothpaste.net> | 2020-09-20 23:22:31 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-09-21 04:29:02 (GMT) |
| commit | 087c61677c358091692ac6ce1de00bbfc9affdb1 (patch) | |
| tree | cd90ca724ddfe7e796fb29db42ef578f26318035 /Documentation | |
| parent | 409f066716598d5050c34b7bb0e6859940428dcf (diff) | |
| download | git-087c61677c358091692ac6ce1de00bbfc9affdb1.zip git-087c61677c358091692ac6ce1de00bbfc9affdb1.tar.gz git-087c61677c358091692ac6ce1de00bbfc9affdb1.tar.bz2 | |
docs: explain how to deal with files that are always modified
Users frequently have problems where two filenames differ only in case,
causing one of those files to show up consistently as being modified.
Let's add a FAQ entry that explains how to deal with that.
In addition, let's explain another common case where files are
consistently modified, which is when files using a smudge or clean
filter have not been run through that filter. Explain the way to fix
this as well.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/gitfaq.txt | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt index 176b097..afdaeab 100644 --- a/Documentation/gitfaq.txt +++ b/Documentation/gitfaq.txt @@ -363,6 +363,39 @@ information about how to configure files as text or binary. You can also control this behavior with the `core.whitespace` setting if you don't wish to remove the carriage returns from your line endings. +[[always-modified-files-case]] +Why do I have a file that's always modified?:: + Internally, Git always stores file names as sequences of bytes and doesn't + perform any encoding or case folding. However, Windows and macOS by default + both perform case folding on file names. As a result, it's possible to end up + with multiple files or directories whose names differ only in case. Git can + handle this just fine, but the file system can store only one of these files, + so when Git reads the other file to see its contents, it looks modified. ++ +It's best to remove one of the files such that you only have one file. You can +do this with commands like the following (assuming two files `AFile.txt` and +`afile.txt`) on an otherwise clean working tree: ++ +---- +$ git rm --cached AFile.txt +$ git commit -m 'Remove files conflicting in case' +$ git checkout . +---- ++ +This avoids touching the disk, but removes the additional file. Your project +may prefer to adopt a naming convention, such as all-lowercase names, to avoid +this problem from occurring again; such a convention can be checked using a +`pre-receive` hook or as part of a continuous integration (CI) system. ++ +It is also possible for perpetually modified files to occur on any platform if a +smudge or clean filter is in use on your system but a file was previously +committed without running the smudge or clean filter. To fix this, run the +following on an otherwise clean working tree: ++ +---- +$ git add --renormalize . +---- + [[recommended-storage-settings]] What's the recommended way to store files in Git?:: While Git can store and handle any file of any type, there are some |