diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2024-04-07 12:41:48 +0200 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2024-05-04 08:21:33 +0000 |
| commit | 495311d2067e85ee1fb53593a4671ef0ec09c6f1 (patch) | |
| tree | abce4096b646b018d8b60c51c38486578fe086d6 | |
| parent | 04154af5d6cd5fe76a2583778379bdacb5aa6fb0 (diff) | |
| download | riscv-openocd-495311d2067e85ee1fb53593a4671ef0ec09c6f1.zip riscv-openocd-495311d2067e85ee1fb53593a4671ef0ec09c6f1.tar.gz riscv-openocd-495311d2067e85ee1fb53593a4671ef0ec09c6f1.tar.bz2 | |
doc: style: report indentation of multi-line condition
To help readability and discriminate the 'then' block from the
multi-line condition, suggest to increase the indentation of the
condition.
Change-Id: I02e3834be3001e7ecf24349ad3cefe94b27b79c8
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/8199
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
Tested-by: jenkins
Reviewed-by: Oleksij Rempel <linux@rempel-privat.de>
| -rw-r--r-- | doc/manual/style.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 1d3ec67..a1e6b8f 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -97,6 +97,21 @@ OpenOCD project. x = 0; } @endcode +- on <tt> if </tt> statements where the condition is split among multiple + lines, increase the indentation of the condition to prevent it to match + to the indentation of the <tt> then </tt> block due to length of 'if (' + being same of the TAB width of 4 characters. Use: + @code + if (CMD_ARGC < 3 + || CMD_ARGC > 8) + return ERROR_COMMAND_SYNTAX_ERROR; + @endcode + instead of: + @code + if (CMD_ARGC < 3 || + CMD_ARGC > 8) + return ERROR_COMMAND_SYNTAX_ERROR; + @endcode Finally, try to avoid lines of code that are longer than 72-80 columns: |