philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Try to fix a numbered list.

Browse Source
This commit is contained in:
David Young
2019-12-20 11:41:06 -06:00
parent 934e8d7e83
commit 7d6dc4d0d4
1 changed files with 62 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
doc/linux-coding-style.md
View File

@@ -65,71 +65,69 @@ Anyway, here goes:
1) Indentation
Tabs are 8 characters, and thus indentations are also 8 characters.
There are heretic movements that try to make indentations 4 (or even 2!)
characters deep, and that is akin to trying to define the value of PI to
be 3.
Tabs are 8 characters, and thus indentations are also 8 characters.
There are heretic movements that try to make indentations 4 (or even 2!)
characters deep, and that is akin to trying to define the value of PI to
be 3.
Rationale: The whole idea behind indentation is to clearly define where
a block of control starts and ends. Especially when you've been looking
at your screen for 20 straight hours, you'll find it a lot easier to see
how the indentation works if you have large indentations.
Now, some people will claim that having 8-character indentations makes
the code move too far to the right, and makes it hard to read on a
80-character terminal screen. The answer to that is that if you need
more than 3 levels of indentation, you're screwed anyway, and should fix
your program.
In short, 8-char indents make things easier to read, and have the added
benefit of warning you when you're nesting your functions too deep. Heed
that warning.
The preferred way to ease multiple indentation levels in a switch
statement is to align the `switch`{.docutils .literal} and its
subordinate `case`{.docutils .literal} labels in the same column instead
of `double-indenting`{.docutils .literal} the `case`{.docutils .literal}
labels. E.g.:
```
switch (suffix) {
case 'G':
case 'g':
mem <<= 30;
break;
case 'M':
case 'm':
mem <<= 20;
break;
case 'K':
case 'k':
mem <<= 10;
/* fall through */
default:
break;
}
```
Don't put multiple statements on a single line unless you have something
to hide:
```
if (condition) do_this;
do_something_everytime;
```
Don't put multiple assignments on a single line either. Kernel coding
style is super simple. Avoid tricky expressions.
Outside of comments, documentation and except in Kconfig, spaces are
never used for indentation, and the above example is deliberately
broken.
Get a decent editor and don't leave whitespace at the end of lines.
Rationale: The whole idea behind indentation is to clearly define where
a block of control starts and ends. Especially when you've been looking
at your screen for 20 straight hours, you'll find it a lot easier to see
how the indentation works if you have large indentations.
Now, some people will claim that having 8-character indentations makes
the code move too far to the right, and makes it hard to read on a
80-character terminal screen. The answer to that is that if you need
more than 3 levels of indentation, you're screwed anyway, and should fix
your program.
In short, 8-char indents make things easier to read, and have the added
benefit of warning you when you're nesting your functions too deep. Heed
that warning.
The preferred way to ease multiple indentation levels in a switch
statement is to align the `switch`{.docutils .literal} and its
subordinate `case`{.docutils .literal} labels in the same column instead
of `double-indenting`{.docutils .literal} the `case`{.docutils .literal}
labels. E.g.:
```
switch (suffix) {
case 'G':
case 'g':
mem <<= 30;
break;
case 'M':
case 'm':
mem <<= 20;
break;
case 'K':
case 'k':
mem <<= 10;
/* fall through */
default:
break;
}
```
Don't put multiple statements on a single line unless you have something
to hide:
```
if (condition) do_this;
do_something_everytime;
```
Don't put multiple assignments on a single line either. Kernel coding
style is super simple. Avoid tricky expressions.
Outside of comments, documentation and except in Kconfig, spaces are
never used for indentation, and the above example is deliberately
broken.
Get a decent editor and don't leave whitespace at the end of lines.
:::
::: {#breaking-long-lines-and-strings .section}
2) Breaking long lines and strings[](#breaking-long-lines-and-strings "Permalink to this headline"){.headerlink}
2) <a name="breaking-long-lines-and-strings">Breaking long lines and strings</a>
Coding style is all about readability and maintainability using commonly
available tools.