Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
C++ C D Objective-C Shell Python Other
Failed to load latest commit information.
documentation Fix some mistakes in the documentation
etc Merge pull request #325 from MarekFort/master
man Update the year in the man page
osx Add missing osx directory.
scripts Added a script that generates uncrustify_version.h on windows.
src Merge branch 'features/msref-support' of https://github.com/Unity-Tec…
tests Merge branch 'features/msref-support' of https://github.com/Unity-Tec…
uncrustify.xcodeproj Added fix for issue #124: #124
win32 Run uncrustify on itself using etc/ben.cfg, with a few manual fixes.
.gitignore Updating “.gitignore” for Xcode 4.
AUTHORS Import r1644 from subversion
BUGS Update BUGS a bit
COPYING Import r1644 from subversion
ChangeLog Update changelog
HELP Import r1644 from subversion
INSTALL Import r1644 from subversion
Makefile.am Use silent rules instead of nostdinc
Makefile.in Re-run autogen.sh on Ubuntu 14.04
NEWS Import r1644 from subversion
README Update the README file to indicate that bugs should go on the sf.net …
TESTING Tweaks to the TESTING how-to
aclocal.m4 Re-run autogen.sh on Ubuntu 14.04
autogen.sh Import r1644 from subversion
commit.log Extract the commit log
compile Re-run autogen.sh on Ubuntu 14.04
config.guess Import r1644 from subversion
config.sub Import r1644 from subversion
configure Documentation and script updates for version 0.61.
configure.ac Bump version to 0.61
extras.vpj Add a few files to the workspace
install-sh Re-run autogen.sh on Ubuntu 14.04
make_token_names.sh Remove the date from token_names.h/make_token_names.sh
make_version.py make_version.py: no need to split lines of uncrustify_version.h.in
make_win32.sh Rework make_win32.sh to build with the latest mingw32.
missing Re-run autogen.sh on Ubuntu 14.04
package.json Added package.json for npm
release-steps.txt Save off changes for version 0.59
run_tests.sh Import r1644 from subversion
test-driver Re-run autogen.sh on Ubuntu 14.04
uncrustify.vpj Add ability to get config from UNCRUSTIFY_CONFIG env var to win32
uncrustify.vpw Update SlickEdit project files
update-default-cfg.sh Import r1644 from subversion
working.txt save off work in the freebsd branch

README

README for Uncrustify
=====================

Post any bugs to the issue tracker found on the project's Sourceforge page:
  http://sourceforge.net/projects/uncrustify

Please include the following with your issue:
 - a description of what is not working right
 - input code sufficient to demonstrate the issue
 - expected output code
 - configuration options used to generate the output

If the issue cannot be easily reproduced, then it isn't likely to be fixed.


Building the program
--------------------

Quick start:
 $ ./configure
 $ make

The executable is src/uncrustify.
Copy that to your ~/bin/ folder or wherever you want.


Building the program using Xcode on Mac OS X
---------------------------------------------

You can of course just open the Xcode project and build uncrustify using the
default 'Debug' configuration but if you want to install it the 'Install'
configuration will not work from within Xcode.

For that you will have to use the Xcode command line tool 'xcodebuild'.

To do that, cd into the uncrustify project folder where uncrustify.xcodeproj
resides and enter the following command:

sudo xcodebuild -configuration 'Install'

You will be prompted for the root level password. By doing this you will install
uncrustify into /usr/local/bin. The install location can be changed by editing
the Build Settings for the uncrustify target. The setting you need to change is
called, surprisingly enough, 'Installation Directory'.


Configuring the program
-----------------------

Examine the example config files in etc and/or read
documentation/htdocs/configuration.txt.
Copy the existing config file that closely matches your style and put in
~/.uncrustify/.  Modify to your liking.


Running the program (and refining your style)
---------------------------------------------

As of the current release, I don't particularly trust this program to not make
mistakes and screw up my whitespace formatting.

Here's how to run it:
$ uncrustify -c ~/.uncrustify/mystyle.cfg -f somefile.c > somefile.c.unc

The -c option selects the configuration file.
The -f option specifies the input file.
The output is sent to stdout.  Error messages are sent to stderr.

Use a quality side-by-side diff tool to determine if the program did what you
wanted.
Repeat until your style is refined.


Running the program (once you've found your style)
--------------------------------------------------

Write a script to automate the above.
Check out etc/dofiles.sh for an example.
That script is used as follows:
1. navigate one level above your project
2. make a list of file to process
  $ find myproj -name "*.[ch]" > files.txt
3. sh etc/dofiles.sh files.txt
4. Use your favorite diff/merge program to merge in the changes
  $ xxdiff out/myproj myproj
Something went wrong with that request. Please try again.