File: clang-format.rst

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (35 lines) | stat: -rw-r--r-- 1,059 bytes parent folder | download | duplicates (15) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
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>`