[checkstyle] 09/14: Updated the manpage and added an example

[Emmanuel Bourg]

This is an automated email from the git hooks/post-receive script.

ebourg-guest pushed a commit to branch master
in repository checkstyle.

commit 0e5b5274ab4dd94008598650af8ff592a8b9d2f2
Author: Emmanuel Bourg <ebourg at apache.org>
Date:   Tue Nov 24 11:18:26 2015 +0100

    Updated the manpage and added an example
---
 debian/changelog      |  1 +
 debian/checkstyle.pod | 12 +++++++++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 3c6e99b..2d8bca7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,6 +6,7 @@ checkstyle (6.12.1-1) UNRELEASED; urgency=medium
     - New dependencies on antlr4 and commons-lang3
     - Disabled the unit tests (too many missing dependencies)
     - No longer install the contrib files (removed upstream)
+    - Updated the manpage and added an example
 
  -- Emmanuel Bourg <ebourg at apache.org>  Thu, 21 May 2015 14:34:06 +0200
 
diff --git a/debian/checkstyle.pod b/debian/checkstyle.pod
index 795d68b..1fdb9eb 100644
--- a/debian/checkstyle.pod
+++ b/debian/checkstyle.pod
@@ -16,6 +16,10 @@ projects that want to enforce a coding standard.
 Checkstyle is highly configurable and can be made to support almost any coding
 standard.
 
+Checkstyle is highly configurable and can be made to support almost any coding
+standard. Example configuration files are supplied supporting the Sun Code
+Conventions and Google Java Style.
+
 For information about Checkstyle, it can be found at
 http://checkstyle.sourceforge.net/.
 
@@ -44,11 +48,13 @@ Specify a properties file to use.
 
 Specify the file to output to.
 
-=item B<-r I<dir>>
+=back
 
-Specify the directory to traverse for Java source files.
+=head1 EXAMPLE
 
-=back
+Check the source files in the src/main/java directory using the Google Java Style:
+
+    checkstyle -c /usr/share/checkstyle/google_checks.xml src/main/java
 
 =head1 SEE ALSO
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/checkstyle.git