X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/2ff05f25846c10b2fee269c29569b96dbac42836..267bc5dde9f4e5e4b6dacdf79cf1688ffe9b7715:/docs/ignoring_unmodified_files.md diff --git a/docs/ignoring_unmodified_files.md b/docs/ignoring_unmodified_files.md deleted file mode 120000 index 4484bfa..0000000 --- a/docs/ignoring_unmodified_files.md +++ /dev/null @@ -1 +0,0 @@ -_build/generated/ignoring_unmodified_files.md \ No newline at end of file diff --git a/docs/ignoring_unmodified_files.md b/docs/ignoring_unmodified_files.md new file mode 100644 index 0000000..a915f4e --- /dev/null +++ b/docs/ignoring_unmodified_files.md @@ -0,0 +1,23 @@ +[//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM README.md" + +# Ignoring unmodified files + +_Black_ remembers files it has already formatted, unless the `--diff` flag is used or +code is passed via standard input. This information is stored per-user. The exact +location of the file depends on the _Black_ version and the system on which _Black_ is +run. The file is non-portable. The standard location on common operating systems is: + +- Windows: + `C:\\Users\\AppData\Local\black\black\Cache\\cache...pickle` +- macOS: + `/Users//Library/Caches/black//cache...pickle` +- Linux: + `/home//.cache/black//cache...pickle` + +`file-mode` is an int flag that determines whether the file was formatted as 3.6+ only, +as .pyi, and whether string normalization was omitted. + +To override the location of these files on macOS or Linux, set the environment variable +`XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache +in the directory you're running _Black_ from, set `XDG_CACHE_HOME=.cache`. _Black_ will +then write the above files to `.cache/black//`.