search

AlDanial / cloc

cloc counts blank lines, comment lines, and physical lines of source code in many programming languages.
GNU General Public License v2.0
19.75k stars 1.02k forks source link

Inconsistency with config file location on windows #846

Closed itsvyle closed 4 months ago

itsvyle commented 4 months ago

Describe the bug In the readme, it is indicated that the config for cloc can be taken from a options.txt file found at C:\Users\USERNAME\AppData\cloc\options.txt (here), but when putting a config file there it isn't used.

However, the help message from cloc --help shows that the config file is instead found at C:\Users\USERNAME\AppData\Roaming\cloc, and this seems to be where the config file is pulled from on windows.

The README documentation seems to forget the Roaming part, as well as the fact that on windows the config file isn't a options.txt file, seems inconsistent

cloc; OS; OS version

To Reproduce Create a file at the C:\Users\USERNAME\AppData\cloc\options.txt location indicated in the README, run cloc --verbose and notice that the config file isn't being used

Expected result Either the file indicated in the readme should be used (would probably be more consistent with what is used on unix, but at the cost of possibly causing backwards compatibility issues), or the documentation should be changed on the readme

Additional context N/A