New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow setting custom cache directory on all platforms with environmen… #2739
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,10 +22,11 @@ run. The file is non-portable. The standard location on common operating systems | |
`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/<version>/`. | ||
To override the location of these files on all systems, set the environment variable | ||
`BLACK_CACHE_DIR` to the preferred location. Alternatively on macOS and Linux, set | ||
`XDG_CACHE_HOME` to you your preferred location. For example, if you want to put the | ||
cache in the directory you're running _Black_ from, set `BLACK_CACHE_DIR=.cache/black`. | ||
_Black_ will then write the above files to `.cache/black`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It may be implied in how this is structured (in which case I'm totally missing it) but it'd be nice to also note that There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agreed! Think this will be a definite improvement! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. addressed |
||
|
||
## .gitignore | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I honestly forgot these docs existed, I should probably fix that haha