svn commit: r882289 - in /incubator/rat/main/trunk: apache-rat-core/src/main/java/org/apache/rat/Report.java apache-rat/src/site/apt/index.apt

[rd...@apache.org]

Author: rdonkin
Date: Thu Nov 19 20:45:22 2009
New Revision: 882289

URL: http://svn.apache.org/viewvc?rev=882289&view=rev
Log:
RAT-30 Improvements to (self-) documentation Thanks to Ross Gardler. https://issues.apache.org/jira/browse/RAT-30

Modified:
    incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java
    incubator/rat/main/trunk/apache-rat/src/site/apt/index.apt

Modified: incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java?rev=882289&r1=882288&r2=882289&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java (original)
+++ incubator/rat/main/trunk/apache-rat-core/src/main/java/org/apache/rat/Report.java Thu Nov 19 20:45:22 2009
@@ -129,7 +129,7 @@
                 "f",
                 "force",
                 false,
-        "Forces any changes in files to be written without confirmation");
+        "Forces any changes in files to be written directly to the source files (i.e. new files are not created)");
         opts.addOption(write);
 
         Option copyright = new Option(
@@ -220,7 +220,7 @@
         footer.append("RAT often requires some tuning before it runs well against a project\n");
         footer.append("RAT relies on heuristics: it may miss issues\n");
 
-        f.printHelp("java rat.report [options] [DIR]",
+        f.printHelp("java org.apache.org.rat.report [options] [DIR]",
                 header, opts, footer.toString(), false);
         System.exit(0);
     }

Modified: incubator/rat/main/trunk/apache-rat/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/apache-rat/src/site/apt/index.apt?rev=882289&r1=882288&r2=882289&view=diff
==============================================================================
--- incubator/rat/main/trunk/apache-rat/src/site/apt/index.apt (original)
+++ incubator/rat/main/trunk/apache-rat/src/site/apt/index.apt Thu Nov 19 20:45:22 2009
@@ -22,3 +22,37 @@
  releases. It is heuristic in nature: making guesses about possible problems. It
  will produce false positives and cannot find every possible issue with a release.
  It's reports require interpretation.
+
+
+* Running from the Command Line
+ 
+ Run from the command line with:
+
++------------------------------------------+
+java -jar rat-VERSION.jar --help
++------------------------------------------+
+
+ Where VERSION is replaced with the version number you are 
+ working with.
+ 
+ This will output a help message detailing the command line
+options available to you.
+
+* Adding licence headers
+
+RAT can be used to automatically add licence headers to 
+files that do not currently have them. Only files that
+are not excluded by the RAT configurations will be affected.
+
+To add licence headers use a command such as:
+
++------------------------------------------+
+java -jar rat-VERSION.jar --addLicence 
+  --copyright "Copyright 2008 Foo" --force
+  /path/to/project
++------------------------------------------+
+
+This command will add the licence header directly to the
+source files. If you prefer to see which files will be
+changed and how then remove the "--force" option. 
+