UNCRUSTIFY
DOCUMENTATION
PROJECT
Before to start, please read this page about U.D.P.
The core of this project is:
- The 7 indexes of all Uncrustify options sorted by
- name, (align_asm_colon ... indent_brace ... nl_after_semicolon ... utf8_force)
- category, (Blank line options, Indenting options, Preprocessor options, Spacing options ...)
- type, (boolean, multiple value, numeric, string)
- keyword, (assign, brace, class, comma ... do, else, for, ... struct, tab, template, ... while)
- exceptions to the default values. (false, 0, ignore)
- linked options (option modifying or being modified by another option)
- tag (bug, fixme, c++, java ...)
- The Comparison table of various configurations.
K&R vs Linux kernel vs FreeBsd vs GNU vs ...
If you don't know how to find the options that match your needs,
you can try searching the indexes by category
or by keyword.
If it seems to you that Uncrustify is doing unexpected things, this may be due to
an option with a non standard default
or to an option linked to another option.
If you start with uncrustify I suggest that you
- Take a look to the various indexes (see above)
- Read the tuto (coming soon) how to write an uncrustify configuration from scratch
- Read the explanations about
parenthesis,
gap-span-threshold and
iarf options.
- If you don't know which format to use, look at this list of recommendations ;-)
- How to manage 850 options?
If you want to contribute look at How to write an .uds file.
For curious there are these tools:
Uncrustify on StackOverflow.
