summaryrefslogtreecommitdiff
path: root/Documentation/coding_style.md
AgeCommit message (Collapse)Author
2021-02-06Documentation: Codify some guidelines for headers and chain-includingJulius Werner
There has been some repeated discussion about how header includes should be formatted, specifically on the topic of chain-including. The coding style currently doesn't say anything about the topic but clearly people have some basic assumptions. This patch tries to codify some common ground rules that are supposed to reflect the existing practice. Signed-off-by: Julius Werner <jwerner@chromium.org> Change-Id: Ibbcde306a814f52b3a41b58c7a33bdd99b0187e0 Reviewed-on: https://review.coreboot.org/c/coreboot/+/50247 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Kyösti Mälkki <kyosti.malkki@gmail.com> Reviewed-by: HAOUAS Elyes <ehaouas@noos.fr> Reviewed-by: Angel Pons <th3fanbus@gmail.com>
2019-09-04Documentation/coding_style.md: Update line length limitAngel Pons
Line length limit was bumped to 96 characters, but the coding style did not reflect such a change. Change-Id: Ifdbb8bc04e49e1fbe9b0c8a642ae814d5a60004a Signed-off-by: Angel Pons <th3fanbus@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/35215 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2019-03-15Revert "Documentation: Our coding style now allows 80 + 2*8 columns in a line"Julius Werner
This reverts commit b3a8cc54dbaf833c590a56f912209a5632b71f49. This change was submitted under the incorrect assumption that there was agreement on a coding style change. There wasn't, so while the issue is under discussion we should revert to the previous status quo. Change-Id: I37a5585764346af11a98bdf58c810dd3cf5bfe40 Signed-off-by: Julius Werner <jwerner@chromium.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/31915 Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2019-03-08Documentation: Our coding style now allows 80 + 2*8 columns in a linePatrick Georgi
Update the document to match clang-format and checkpatch formally, and provide a rationale. Change-Id: I597a27d4e22d07e033b36f0dceb554ac1d8d5789 Signed-off-by: Patrick Georgi <pgeorgi@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/31771 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
2019-01-30Documentation: Add coding styleArthur Heymans
This is the old wiki page https://www.coreboot.org/Coding_Style coverted from mediawiki to markdown. Change-Id: Id56a8b7500121c4d9c18bc0b6bbc2c05402268dc Signed-off-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-on: https://review.coreboot.org/c/30834 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Patrick Georgi <pgeorgi@google.com>