[libcamera-devel,v4,0/2] Documentation: coding style and style checker tool

Message ID 1544612976-27101-1-git-send-email-jacopo@jmondi.org
Headers show
Series
  • Documentation: coding style and style checker tool
Related show

Message

Jacopo Mondi Dec. 12, 2018, 11:09 a.m. UTC
Hello,
   this patch adds the 'coding style' section to the project's Documentation.

Along with the the documentation itself, the second patch adds an intial
attempt to implement a style checker script, that uses astyle to validate the
changes as recorded in the topmost git commit. Also, add documentation on how
to use the tool to the previously introduced coding-style.rst.

The script is in a -very- early stage, tested locally only, on
GNU bash, version 4.3.48(1)-release.

I expect a lot of false positive (good) and also a lot of false negatives (bad,
as we don't see what the script has missed easily).

In future we might want to re-implement it in something saner than plain shell
scripting, but for now please use it locally, and report errors as you see them.

Thanks
   j

Jacopo Mondi (2):
  Documentation: Add coding style document
  Documentation: Add style checker tool

 Documentation/coding-style.rst | 125 ++++++++++++++++++++++++++++++++++++
 Documentation/index.rst        |   1 +
 Documentation/meson.build      |   1 +
 utils/checkstyle.sh            | 141 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 268 insertions(+)
 create mode 100644 Documentation/coding-style.rst
 create mode 100755 utils/checkstyle.sh

--
2.7.4