From db2b31ae4b2a8c19a620141982b70aa75d3f3fa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89der=20F=2E=20Zulian?= Date: Thu, 12 Apr 2018 23:25:26 +0200 Subject: [PATCH] Coding style script improved and doc updated --- coding-style.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/coding-style.md b/coding-style.md index 7b686d65..d0509550 100644 --- a/coding-style.md +++ b/coding-style.md @@ -26,9 +26,9 @@ sudo apt-get -y install clang-format ``` **Hint:** -You can use [utils/install.sh](./utils/install.sh) in order to install -dependencies. First read and understand the script then execute it. Type your -password if required. +You can use [install.sh](./utils/install.sh) in order to install dependencies. +First read and understand the script then execute it. Type your password if +required. ## DRAMSys Coding Style for C++ Code @@ -145,14 +145,21 @@ There is a plugin for VIM. More information can be found in + Select the **Enable auto format on file save** check box to automatically beautify files when you save them. +## Applying the Coding Style + +The script [make_pretty.sh](./utils/make_pretty.sh) applies the coding style +to the project excluding thrid party code. ## References -[Linux kernel coding style](https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst) +[Linux kernel coding +style](https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst) -[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#S-cpl) +[C++ Core +Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#S-cpl) -[PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/) +[PEP 8 -- Style Guide for Python +Code](https://www.python.org/dev/peps/pep-0008/) [Qt Documentation - Beautifying Source Code](http://doc.qt.io/qtcreator/creator-beautifier.html)