ceph/src/jaegertracing/opentelemetry-cpp/third_party/nlohmann-json/third_party/cpplint/README.rst

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