mirror of
https://github.com/google/styleguide.git
synced 2024-03-22 13:11:43 +08:00
8a87a46cc7
Also further improve the documentation and testing around --root. Previously the root=setting in the CFG file was treated identically to passing --root=setting on the command line, which seems undesirable since it depends on were cpplint.cfg was invoked from (for relative paths). Judging on settings such as 'exclude_files' it seems within the spirit to make the settings 'current working directory' contextual to the same directory that CPPLINT.cfg is in. This also makes execution consistent (picking up the "correct" settings) regardless of the CWD when executing cpplint.py. Example: echo 'root=..' >> /a/b/c/CPPLINT.cfg cd / cpplint.py /a/b/c/source_file.h # expects header guard of C_SOURCE_FILE_H_ However the old behavior would use '/../' = '/' and incorrectly think the root was 'A_B_C_SOURCE_FILE_H_'. |
||
|---|---|---|
| .. | ||
| nested | ||
| cpplint_test_header.h | ||
| cpplint_unittest.py | ||
| cpplint.py | ||
| README | ||
This is automated checker to make sure a C++ file follows Google's C++ style guide (https://google.github.io/styleguide/cppguide.html). As it heavily relies on regular expressions, cpplint.py won't catch all violations of the style guide and will very occasionally report a false positive. There is a list of things we currently don't handle very well at the top of cpplint.py, and we welcome patches to improve it. The linting tool takes a list of files as input. For full usage instructions, please see the output of: ./cpplint.py --help Unit tests are provided in cpplint_unittest.py. This file can safely be ignored by end users who have downloaded this package and only want to run the lint tool. --- cpplint.py and its corresponding unit tests are Copyright (C) 2009 Google Inc. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Google Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.