TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 28 Pull requests Projects 6 Releases Packages Wiki Activity

Coding Style Document for BigWhoop #12

New issue
Open
opened 2023-06-20 12:59:04 +00:00 by Patrick Vogler · 0 comments
Patrick Vogler commented 2023-06-20 12:59:04 +00:00
Owner
Copy link

Summary

Multiple parties might need to work on the source code if it is folded into different hpc projects. To ensure that the work that goes into the code is readable, maintainable and iterable consistency in the work needs to be enforced. A coding style document will allow project newcomers to adapt to the coding style used for BigWhoop.

The following coding style that are widely used will be used as a basis for the document:

  1. GNU Coding Standard
  2. Tilen MAJERLE
  3. Linux Kernel Coding Style
  4. Nasa Coding Style
  5. Indian Hill C Coding Style

Additional Coding Style Resources

Link

## Summary Multiple parties might need to work on the source code if it is folded into different hpc projects. To ensure that the work that goes into the code is readable, maintainable and iterable consistency in the work needs to be enforced. A coding style document will allow project newcomers to adapt to the coding style used for BigWhoop. The following coding style that are widely used will be used as a basis for the document: 1. [GNU Coding Standard](https://www.gnu.org/prep/standards/html_node/Writing-C.html) 2. [Tilen MAJERLE](https://github.com/MaJerle/c-code-style) 3. [Linux Kernel Coding Style](https://web.archive.org/web/20181231053642/http://www.maultech.com/chrislott/resources/cstyle/LinuxKernelCodingStyle.txt) 4. [Nasa Coding Style](https://web.archive.org/web/20190125125043/http://homepages.inf.ed.ac.uk/dts/pm/Papers/nasa-c-style.pdf) 5. [Indian Hill C Coding Style](https://web.archive.org/web/20200113111136/http://www.maultech.com/chrislott/resources/cstyle/indhill-cstyle.pdf) ### Additional Coding Style Resources [Link](https://web.archive.org/web/20190407233045/https://www.maultech.com/chrislott/resources/cstyle/)
Patrick Vogler added this to the Coding Style Document milestone 2023-06-20 12:59:04 +00:00
Patrick Vogler self-assigned this 2023-06-20 12:59:04 +00:00
Patrick Vogler added this to the Documentation project 2023-06-20 12:59:04 +00:00
Patrick Vogler removed their assignment 2024-04-09 11:16:41 +00:00
Sign in to join this conversation.
streaming
Branches Tags
Clear current reference
main
develop-gws
feat/api
docs/template
git/config
develop-pv
hipify
streaming
Clear current reference
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Coding Style Document
Projects
Clear projects
No items
No project
Documentation
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: TOPIO/BigWhoop#12
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?