forked from mirrors/gecko-dev
e818e28315
This is more to demonstrate the use of the role than anything else. Differential Revision: https://phabricator.services.mozilla.com/D152125
35 lines
1 KiB
ReStructuredText
35 lines
1 KiB
ReStructuredText
clang-format
|
|
============
|
|
|
|
`clang-format <https://clang.llvm.org/docs/ClangFormat.html>`__ is a tool to reformat C/C++ to the right coding style.
|
|
|
|
Run Locally
|
|
-----------
|
|
|
|
The mozlint integration of clang-format can be run using mach:
|
|
|
|
.. parsed-literal::
|
|
|
|
$ mach lint --linter clang-format <file paths>
|
|
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
To enable clang-format on new directory, add the path to the include
|
|
section in the :searchfox:`clang-format.yml <tools/lint/clang-format.yml>` file.
|
|
|
|
While excludes: will work, this linter will read the ignore list from :searchfox:`.clang-format-ignore file <.clang-format-ignore>`
|
|
at the root directory. This because it is also used by the ./mach clang-format -p command.
|
|
|
|
Autofix
|
|
-------
|
|
|
|
clang-format can reformat the code with the option `--fix` (based on the upstream option `-i`).
|
|
To highlight the results, we are using the ``--dry-run`` option (from clang-format 10).
|
|
|
|
Sources
|
|
-------
|
|
|
|
* :searchfox:`Configuration (YAML) <tools/lint/clang-format.yml>`
|
|
* :searchfox:`Source <tools/lint/clang-format/__init__.py>`
|