From patchwork Wed Dec 12 11:09:34 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jacopo Mondi X-Patchwork-Id: 37 Return-Path: Received: from relay10.mail.gandi.net (relay10.mail.gandi.net [217.70.178.230]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 32D9660A71 for ; Wed, 12 Dec 2018 12:09:54 +0100 (CET) Received: from w540.lan (2-224-242-101.ip172.fastwebnet.it [2.224.242.101]) (Authenticated sender: jacopo@jmondi.org) by relay10.mail.gandi.net (Postfix) with ESMTPSA id A23DE24001C; Wed, 12 Dec 2018 11:09:53 +0000 (UTC) From: Jacopo Mondi To: libcamera-devel@lists.libcamera.org Date: Wed, 12 Dec 2018 12:09:34 +0100 Message-Id: <1544612976-27101-1-git-send-email-jacopo@jmondi.org> X-Mailer: git-send-email 2.7.4 Subject: [libcamera-devel] [PATCH v4 0/2] Documentation: coding style and style checker tool X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 12 Dec 2018 11:09:54 -0000 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