|
Size: 3765
Comment: Document how to uncrustify code without "hg uncrustify" (issue969, which is not merged yet).
|
Size: 1065
Comment: Remove "hg uncrustify" docs.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 20: | Line 20: |
== Mercurial "uncrustify" extension == The repository contains a Mercurial extension (in file {{{misc/style/uncrustify.py}}}) that provides the new command {{{ hg uncrustify }}} to automatically run {{{uncrustify}}} with the correct settings on your working directory. === Using the extension === Examples: {{{ hg uncrustify hg uncrustify . hg uncrustify --diff bar/baz.cc foo hg uncrustify --modify foo hg uncrustify --modify --no-backup foo }}} In order, these do the following: * List all files in the repository that need to be uncrustified (i.e. which violate the formatting conventions). * List all files in the repository below the current working directory that need to be uncrustified. * Show the diff that would need to be applied to uncrustify source file {{{bar/baz.cc}}} as well as all source files below directory {{{foo}}}. * Uncrustify all source files below directory {{{foo}}}. Backup files with extension {{{.crusty}}} are generated for all modified files, containing the original (not yet uncrustified) source. * Like the previous command, but without creating backups. For more details, run {{{ hg help uncrustify }}} === Setting up the extension === /!\ Warning: Mercurial extensions can execute arbitrary code on your machine. If you don't trust everyone with write access to whatever repository you grabbed {{{uncrustify.py}}} from, don't use it. First of all, you will need {{{uncrustify}}} itself. We require exactly version 0.67 which is the version that runs on our buildbots (newer versions may change formatting rules again). Since this version is in none of the Ubuntu repositories, we provide the steps for compiling and installing it: {{{ wget https://github.com/uncrustify/uncrustify/archive/uncrustify-0.67.tar.gz tar -xzvf uncrustify-0.67.tar.gz cd uncrustify-uncrustify-0.67 mkdir build cd build cmake ../ make -j8 mv uncrustify ~/bin/ # Or somewhere else on your PATH. hash -r # Clear PATH cache. uncrustify --version # Output should be "Uncrustify-0.67_f". }}} To set up the actual extension, add the following lines to your {{{hgrc}}}: {{{ [extensions] uncrustify = FULL_PATH_TO/uncrustify.py }}} where {{{FULL_PATH_TO/uncrustify.py}}} is the full path to the {{{uncrustify.py}}} file (absolute, but may use {{{~}}} expansion). Alternatively, install {{{uncrustify.py}}} in some directory on your {{{PYTHONPATH}}} and write {{{ [extensions] uncrustify = }}} in your {{{hgrc}}} instead of providing the full path to the source file. The {{{alias}}} section above is optional. It makes {{{hg uncrustify}}} ignore the {{{src/VAL}}} directory, which does not need to be uncrustified. |
Back to developer page.
Using uncrustify to fix code layout
We use uncrustify with a Fast Downward configuration file (.uncrustify.cfg in the repository root) to enforce some of our formatting conventions. If a source file is properly formatted, applying uncrustify should be an idempotent operation (i.e., result in an identical file). This is important so that we can verify our style rules automatically, at least for those rules which uncrustify can handle.
Not all aspects of source layout are handled by uncrustify, so please still pay attention to our ../Whitespace rules and other ../CodingConventions.
Running uncrustify
To check the formatting of all C++ files, use ./misc/run-uncrustify.py. To actually edit the files that need to be uncrustified, use ./misc/run-uncrustify.py --modify. This script is also part of our tox tests:
sudo apt install tox cd misc/ tox -e fix-style
To check the style of Python and C++ files, you can use tox -e style.