interesting
/
riscv-openocd
mirror of https://github.com/riscv/riscv-openocd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc/manual/style: Do not use 'Yoda conditions' 

For more details, see:
https://en.wikipedia.org/wiki/Yoda_conditions
https://sektorvanskijlen.wordpress.com/2019/05/16/conditional-inversion-very-harmful-myth/

Change-Id: If1a8a5f1d0fd345b7cc0c7b5dee6d0d47f9d7fc2
Signed-off-by: Marc Schink <dev@zapb.de>
Reviewed-on: http://openocd.zylin.com/6132
Reviewed-by: Tarek BOCHKATI <tarek.bouchkati@gmail.com>
Tested-by: jenkins
Reviewed-by: Oleksij Rempel <linux@rempel-privat.de>
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
This commit is contained in:
Marc Schink 2021-04-02 11:17:00 +02:00 committed by Antonio Borneo
parent 96aaa77f72
commit 134d7d5a58
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/manual/style.txt
View File

@ -135,13 +135,13 @@ should write statements like the following:
@code @code
// separate statements should be preferred // separate statements should be preferred
result = foo(); result = foo();
if (ERROR_OK != result) if (result != ERROR_OK)
... ...
@endcode @endcode
More directly, do @b not combine these kinds of statements: More directly, do @b not combine these kinds of statements:
@code @code
// Combined statements should be avoided // Combined statements should be avoided
if (ERROR_OK != (result = foo())) if ((result = foo()) != ERROR_OK)
return result; return result;
@endcode @endcode