amiro-os / tools / cpplint / python / README @ 9e75cdad
History | View | Annotate | Download (2.162 KB)
| 1 |
This is automated checker to make sure a C++ file follows Google's C++ style |
|---|---|
| 2 |
guide (http://google.github.io/styleguide/cppguide.html). As it |
| 3 |
heavily relies on regular expressions, cpplint.py won't catch all violations of |
| 4 |
the style guide and will very occasionally report a false positive. There is a |
| 5 |
list of things we currently don't handle very well at the top of cpplint.py, |
| 6 |
and we welcome patches to improve it. |
| 7 |
|
| 8 |
The linting tool takes a list of files as input. For full usage instructions, |
| 9 |
please see the output of: |
| 10 |
|
| 11 |
./cpplint.py --help |
| 12 |
|
| 13 |
Unit tests are provided in cpplint_unittest.py. This file can safely be ignored |
| 14 |
by end users who have downloaded this package and only want to run the lint |
| 15 |
tool. |
| 16 |
|
| 17 |
--- |
| 18 |
|
| 19 |
cpplint.py and its corresponding unit tests are Copyright (C) 2009 Google Inc. |
| 20 |
|
| 21 |
Redistribution and use in source and binary forms, with or without |
| 22 |
modification, are permitted provided that the following conditions are |
| 23 |
met: |
| 24 |
|
| 25 |
* Redistributions of source code must retain the above copyright |
| 26 |
notice, this list of conditions and the following disclaimer. |
| 27 |
* Redistributions in binary form must reproduce the above |
| 28 |
copyright notice, this list of conditions and the following disclaimer |
| 29 |
in the documentation and/or other materials provided with the |
| 30 |
distribution. |
| 31 |
* Neither the name of Google Inc. nor the names of its |
| 32 |
contributors may be used to endorse or promote products derived from |
| 33 |
this software without specific prior written permission. |
| 34 |
|
| 35 |
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 36 |
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 37 |
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 38 |
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 39 |
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 40 |
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 41 |
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 42 |
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 43 |
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 44 |
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 45 |
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |