Index: tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/cmdhelp/CmdHelpMojo.java =================================================================== --- tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/cmdhelp/CmdHelpMojo.java (revision 1103950) +++ tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/cmdhelp/CmdHelpMojo.java (working copy) @@ -54,7 +54,7 @@ /** * Generates docbook for Karaf commands * - * @version $Revision: 1.1 $ + * @version $Revision$ * @goal cmdhelp * @phase generate-resources * @execute phase="generate-resources" @@ -92,6 +92,15 @@ * @parameter default-value="project" */ protected String classLoader; + + + /** + * Adds the --help option to every commands documentation + * + * @parameter default-value="true" + */ + protected boolean includeHelpOption; + private static final String FORMAT_CONF = "conf"; private static final String FORMAT_DOCBX = "docbx"; @@ -128,9 +137,13 @@ for (Class clazz : classes) { try { - String help = new HelpPrinter(clazz).printHelp(format); + String help = new HelpPrinter(clazz).printHelp(format, includeHelpOption); Command cmd = (Command) clazz.getAnnotation(Command.class); File output = null; + + // skip the *-help command + if(cmd.scope().equals("*")) continue; + if (FORMAT_DOCBX.equals(format)) { output = new File(targetFolder, cmd.scope() + "-" + cmd.name() + ".xml"); } else if (FORMAT_CONF.equals(format)) { @@ -195,7 +208,7 @@ this.actionClass = actionClass; } - public String printHelp(String format) throws Exception { + public String printHelp(String format, boolean includeHelpOption) throws Exception { PrintStream oldout = System.out; try { Action action = actionClass.newInstance(); @@ -205,9 +218,9 @@ System.setOut(newout); ActionPreparator preparator; if (FORMAT_DOCBX.equals(format)) { - preparator = new DocbxPreparator(); + preparator = new DocbxPreparator(includeHelpOption); } else { - preparator = new ConfPreparator(); + preparator = new ConfPreparator(includeHelpOption); } preparator.prepare(action, session, Collections.singletonList("--help")); newout.close(); @@ -219,7 +232,13 @@ } protected class DocbxPreparator extends BlueprintActionPreparator { - + + boolean includeHelpOption; + + DocbxPreparator(boolean includeHelpOption){ + this.includeHelpOption = includeHelpOption; + } + @Override protected void printUsage(CommandSession session, Action action, Map optionsMap, Map argsMap, PrintStream out) { @@ -231,7 +250,7 @@ } }); Set