fix(docs): uncrustify.cfg location #15817

This commit is contained in:
kylo252 2021-10-02 23:32:18 +02:00 committed by GitHub
parent ac973d5532
commit 09307e64df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -220,10 +220,11 @@ You can lint a single file (but this will _not_ exclude legacy errors):
- Style rules are (mostly) defined by `src/uncrustify.cfg` which tries to match
the [style-guide]. To use the Nvim `gq` command with `uncrustify`:
```
if !empty(findfile('src/.uncrustify', ';'))
setlocal formatprg=uncrustify\ -q\ -c\ src/uncrustify.cfg\ --replace\ --no-backup
if !empty(findfile('src/uncrustify.cfg', ';'))
setlocal formatprg=uncrustify\ -q\ -l\ C\ -c\ src/uncrustify.cfg\ --no-backup
endif
```
The required version of `uncrustify` is specified in `uncrustify.cfg`.
- There is also `.clang-format` which has drifted from the [style-guide], but
is available for reference. To use the Nvim `gq` command with `clang-format`:
```