michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: contribution guidelines: Clarify use of uncrustify

Browse source 
A few new contributors, after reading the uncrustify section
of the contribution guidelines, have decided to run
existing Zephyr files thru uncrustify, and include in commits
with minor fixes lots of styles changes.
This is something we do not want to encourage.

To avoid this, modify a bit the uncrustify section to
discourage people from doing just that.

Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
This commit is contained in:
Alberto Escolar Piedras 2019-09-30 14:11:30 +02:00 • committed by Alberto Escolar
commit f520a221ab
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/contribute/index.rst
View file

@ -297,7 +297,8 @@ uncrustify
==========
The `uncrustify tool <https://sourceforge.net/projects/uncrustify>`_ can
be helpful to quickly reformat your source code to our `Coding Style`_
be helpful to quickly reformat large amounts of new source code to our
`Coding Style`_
standards together with a configuration file we've provided:
.. code-block:: bash
@ -307,6 +308,10 @@ standards together with a configuration file we've provided:
# On Windows
uncrustify --replace --no-backup -l C -c %ZEPHYR_BASE%\.uncrustify.cfg my_source_file.c
But note that you should not use uncrustify to reformat existing Zephyr code,
or to modify files in which you only introduce a small fix. This would create a
lot of unwelcome extra changed lines.
On Linux systems, you can install uncrustify with
.. code-block:: bash