derek/DRAMSys
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Coding style script improved and doc updated

Browse Source
This commit is contained in:
Éder F. Zulian
2018-04-12 23:25:26 +02:00
parent da565df24d
commit db2b31ae4b
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
coding-style.md
View File

@@ -26,9 +26,9 @@ sudo apt-get -y install clang-format
``` ```
**Hint:** **Hint:**
You can use [utils/install.sh](./utils/install.sh) in order to install You can use [install.sh](./utils/install.sh) in order to install dependencies.
dependencies. First read and understand the script then execute it. Type your First read and understand the script then execute it. Type your password if
password if required. required.
## DRAMSys Coding Style for C++ Code ## 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 + Select the **Enable auto format on file save** check box to automatically
beautify files when you save them. 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 ## 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) [Qt Documentation - Beautifying Source Code](http://doc.qt.io/qtcreator/creator-beautifier.html)