• Home
Name
Date
Size
#Lines
LOC

..--

README.rstD12-May-20242.5 KiB8051

cpplint.pyD12-May-2024256.2 KiB6,9104,623

update.shD12-May-2024163 52

README.rst

1cpplint - static code checker for C++
2=====================================
3
4.. image:: https://img.shields.io/pypi/v/cpplint.svg
5    :target: https://pypi.python.org/pypi/cpplint
6
7.. image:: https://img.shields.io/pypi/pyversions/cpplint.svg
8    :target: https://pypi.python.org/pypi/cpplint
9
10.. image:: https://img.shields.io/pypi/status/cpplint.svg
11    :target: https://pypi.python.org/pypi/cpplint
12
13.. image:: https://img.shields.io/pypi/l/cpplint.svg
14    :target: https://pypi.python.org/pypi/cpplint
15
16.. image:: https://img.shields.io/pypi/dd/cpplint.svg
17    :target: https://pypi.python.org/pypi/cpplint
18
19.. image:: https://img.shields.io/pypi/dw/cpplint.svg
20    :target: https://pypi.python.org/pypi/cpplint
21
22.. image:: https://img.shields.io/pypi/dm/cpplint.svg
23    :target: https://pypi.python.org/pypi/cpplint
24
25Cpplint is a command-line tool to check C/C++ files for style issues following `Google's C++ style guide <http://google.github.io/styleguide/cppguide.html>`_.
26Cpplint is developed and maintained by Google Inc. at `google/styleguide <https://github.com/google/styleguide>`_, also see the `wikipedia entry <http://en.wikipedia.org/wiki/Cpplint>`_
27
28While Google maintains cpplint, Google is not (very) responsive to issues and pull requests, this fork aims to be (somewhat) more open to add fixes to cpplint to enable fixes, when those fixes make cpplint usable in wider contexts.
29Also see discussion here https://github.com/google/styleguide/pull/528.
30
31
32Installation
33============
34
35
36To install cpplint from PyPI, run:
37
38.. code-block:: bash
39
40    $ pip install cpplint
41
42Then run it with:
43
44.. code-block:: bash
45
46    $ cpplint [OPTIONS] files
47
48For full usage instructions, run:
49
50.. code-block:: bash
51
52    $ cpplint --help
53
54Changes
55-------
56
57The modifications in this fork are minor fixes and cosmetic changes, such as:
58
59* python 3 compatibility
60* more default file extensions
61* customizable file extensions with the --extensions argument
62* continuous integration on github
63* support for recursive file discovery via the --recursive argument
64* support for excluding files via --exclude
65* JUnit XML output format
66* Overriding repository root auto-detection via --repository
67* Support ``#pragma once`` as an alternative to header include guards
68* ... and a few more (most of which are open PRs on upstream)
69
70
71Acknowledgements
72----------------
73
74Thanks to Google Inc. for open-sourcing their in-house tool.
75Thanks to maintainers of the fork
76
77* `tkruse <https://github.com/tkruse>`_
78* `mattyclarkson <https://github.com/mattyclarkson>`_
79* `theandrewdavis <https://github.com/theandrewdavis>`_
80