summaryrefslogtreecommitdiff
path: root/devel/astyle/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'devel/astyle/DESCR')
-rw-r--r--devel/astyle/DESCR22
1 files changed, 22 insertions, 0 deletions
diff --git a/devel/astyle/DESCR b/devel/astyle/DESCR
new file mode 100644
index 00000000000..ad4bb342019
--- /dev/null
+++ b/devel/astyle/DESCR
@@ -0,0 +1,22 @@
+When indenting source code, we as programmers have a tendency to
+use both spaces and tab characters to create the wanted indentation.
+Moreover, some editors by default insert spaces instead of tabs
+when pressing the tab key, and other editors (Emacs for example)
+have the ability to "pretty up" lines by automatically setting up
+the white space before the code on the line, possibly inserting
+spaces in a code that up to now used only tabs for indentation.
+
+Since the NUMBER of space characters showed on screen for each tab
+character in the source code changes between editors (until the
+user sets up the number to his liking...), one of the standard
+problems facing programmers when moving from one source code editor
+to another is that code containing both spaces and tabs that was
+up to now perfectly indented, suddently becomes a mess to look at
+when changing to another editor. Even if you as a programmer take
+care to ONLY use spaces or tabs, looking at other peoples source
+code can still be problematic.
+
+To address this problem I have created Artistic Style - a series
+of filters, written in C++, that automatically reindent & reformat
+C/C++/Java source files. These can be used from a command line, or
+it can be incorporated as classes in another C++ program.