]> git.ipfire.org Git - thirdparty/lxc.git/commit
CODING_STYLE: Update section header format
authorTobin C. Harding <me@tobin.cc>
Fri, 17 Aug 2018 04:40:45 +0000 (14:40 +1000)
committerChristian Brauner <christian.brauner@ubuntu.com>
Mon, 10 Dec 2018 15:20:56 +0000 (16:20 +0100)
commit34484cdaf528083f6d777097b93c74960ab1f48e
treefac17790b37a71b6d63f1e344fd7a4a8ef30608d
parentf2872db03a598b05b4f213ba4461e52ac11def69
CODING_STYLE: Update section header format

Currently for section headings we use fourth level markdown heading
level (####).  We do not have levels two or three.

We can use standard incremental levels for heading adornments i.e

1) =========
2) ##
3) ###
ect.

Since this document is likely referenced by maintainers when guiding new
contributors it can save maintainer time to be able to quickly reference
a section in the coding stlye guide.  If we add numbers to each heading
(like the kernel stlye guide) then maintainers can say:

   Nice patch, please see section 3 of the coding style guide and ...

So, this patch makes two changes

- Use incremental level heading adornments
- Add a number to each section heading

Signed-off-by: Tobin C. Harding <me@tobin.cc>
CODING_STYLE.md