Author: dennisl Date: Thu Mar 1 13:18:56 2007 New Revision: 513503 URL: http://svn.apache.org/viewvc?view=rev&rev=513503 Log: o Set EOL style to native.
Modified: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java (props changed) maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java (props changed) maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java (props changed) maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt (props changed) maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt (contents, props changed) maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (contents, props changed) maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml (props changed) Propchange: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/ActiveProfilesMojo.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/plugins/trunk/maven-help-plugin/src/main/java/org/apache/maven/plugins/help/EffectiveSettingsMojo.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/plugins/trunk/maven-help-plugin/src/site/apt/examples/describe-configuration.apt ------------------------------------------------------------------------------ svn:eol-style = native Modified: maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt?view=diff&rev=513503&r1=513502&r2=513503 ============================================================================== --- maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt (original) +++ maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt Thu Mar 1 13:18:56 2007 @@ -1,44 +1,44 @@ - ------ - Introduction - ------ - Maria Odea Ching - ------ - 7 July 2006 - ------ - - -Maven 2 Help Plugin - - The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description - of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom - and effective settings of the current build, and the profiles applied to the current project being built. - -* Goals Overview - - The Help plugin has the following goals: - - * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build. - - * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project. - - * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires - the groupId and artifactId or the plugin prefix of the plugin to be specified. - - * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active - profiles factored in. - - * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any - profile enhancement and the inheritance of the global settings into the user-level settings. - -* Usage - - Instructions on how to use the Help Plugin can be found {{{usage.html}here}}. - -* Examples - - To provide you with better understanding on some usages of the Help plugin, you can take a look into the - following example(s): - - * {{{examples/describe-configuration.html}Configuring Describe Mojo}} - - + ------ + Introduction + ------ + Maria Odea Ching + ------ + 7 July 2006 + ------ + + +Maven 2 Help Plugin + + The Maven 2 Help Plugin is used to get relative information about a project. It can be used to get a description + of a particular plugin, including the plugin's mojos with their parameters and component requirements, the effective pom + and effective settings of the current build, and the profiles applied to the current project being built. + +* Goals Overview + + The Help plugin has the following goals: + + * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build. + + * {{{dependencies-mojo.html}help:dependencies}} prints out the dependency tree for the project. + + * {{{describe-mojo.html}help:describe}} describes the attirbutes of a plugin and/or plugin mojo. For its execution, it requires + the groupId and artifactId or the plugin prefix of the plugin to be specified. + + * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM for the current build, with the active + profiles factored in. + + * {{{effective-settings-mojo.html}help:effective-settings}} prints out the calculated settings for the project, given any + profile enhancement and the inheritance of the global settings into the user-level settings. + +* Usage + + Instructions on how to use the Help Plugin can be found {{{usage.html}here}}. + +* Examples + + To provide you with better understanding on some usages of the Help plugin, you can take a look into the + following example(s): + + * {{{examples/describe-configuration.html}Configuring Describe Mojo}} + + Propchange: maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt ------------------------------------------------------------------------------ svn:eol-style = native Modified: maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt?view=diff&rev=513503&r1=513502&r2=513503 ============================================================================== --- maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (original) +++ maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt Thu Mar 1 13:18:56 2007 @@ -1,91 +1,91 @@ - ------ - Usage - ------ - John Casey - Maria Odea Ching - ------ - 10 July 2006 - ------ - -Usage - - Below are the different goals and configuration of the Help plugin. - -* The <<<help:active-profiles>>> Mojo - - The <<<active-profiles>>> mojo is used to discover which profiles have been applied to the projects currently being built. - For each project in the build session, it will output a list of profiles which have been applied to that project, along - with the source of the profile (POM, settings.xml, or profiles.xml). - - Optionally, the output parameter can be specified to divert this output to a file. - - You can execute this mojo using the following command: - -+-----+ -mvn help:active-profiles -Doutput=/path/to/file -+-----+ - -* The <<<help:dependencies>>> Mojo - - The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built. - It will output the resolved tree of dependencies that the Maven build process actually uses. - - Optionally, the output parameter can be specified to divert this output to a file. - - You can execute this mojo using the following command: - -+-----+ -mvn help:dependencies -Doutput=/path/to/file -+-----+ - -* The <<<help:describe>>> Mojo - - The <<<describe>>> mojo is used to discover information about Maven plugins. Given a plugin prefix or groupId, artifactId, - and optionally version, the mojo will lookup that plugin and output details about it. If the user also specifies - which mojo to describe, the <<describe>> mojo will limit output to the details of that mojo, including parameters. - - Optionally, the output parameter can be specified to divert this output to a file. - - This mojo requires either the groupId and artifactId parameters or the plugin parameter to be specified: - -+-----+ -mvn help:describe -DgroupId=org.somewhere - -DartifactId=some-plugin -Dversion=0.0.0 -+-----+ - - or - -+-----+ -mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0 -+-----+ - - (NOTE: version is always optional here.) - -* The <<<help:effective-pom>>> Mojo - - The <<<effective-pom>>> mojo is used to make visible the POM that results from the application of interpolation, inheritance, - and active profiles. It provides a useful way of removing the guesswork about just what ends up in the POM that Maven uses - to build your project. It will iterate over all projects in the current build session, printing the effective POM for each. - - Optionally, the output parameter can be specified to divert this output to a file. - - The mojo can be executedd using the following command: - -+-----+ -mvn help:effective-profiles -Doutput=/path/to/file -+-----+ - -* The <<<help:effective-settings>>> Mojo - - The <<<effective-settings>>> mojo is used to view the Settings that Maven actually uses to run the build. This Settings - instance is a result of merging the global file with the user's file, with the user's file taking precedence. - - Optionally, the output parameter can be specified to divert this output to a file. - - The mojo can be executedd using the following command: - -+-----+ -mvn help:effective-settings -Doutput=/path/to/file -+-----+ - - + ------ + Usage + ------ + John Casey + Maria Odea Ching + ------ + 10 July 2006 + ------ + +Usage + + Below are the different goals and configuration of the Help plugin. + +* The <<<help:active-profiles>>> Mojo + + The <<<active-profiles>>> mojo is used to discover which profiles have been applied to the projects currently being built. + For each project in the build session, it will output a list of profiles which have been applied to that project, along + with the source of the profile (POM, settings.xml, or profiles.xml). + + Optionally, the output parameter can be specified to divert this output to a file. + + You can execute this mojo using the following command: + ++-----+ +mvn help:active-profiles -Doutput=/path/to/file ++-----+ + +* The <<<help:dependencies>>> Mojo + + The <<<dependencies>>> mojo is used to view the dependency hierarchy of the project currently being built. + It will output the resolved tree of dependencies that the Maven build process actually uses. + + Optionally, the output parameter can be specified to divert this output to a file. + + You can execute this mojo using the following command: + ++-----+ +mvn help:dependencies -Doutput=/path/to/file ++-----+ + +* The <<<help:describe>>> Mojo + + The <<<describe>>> mojo is used to discover information about Maven plugins. Given a plugin prefix or groupId, artifactId, + and optionally version, the mojo will lookup that plugin and output details about it. If the user also specifies + which mojo to describe, the <<describe>> mojo will limit output to the details of that mojo, including parameters. + + Optionally, the output parameter can be specified to divert this output to a file. + + This mojo requires either the groupId and artifactId parameters or the plugin parameter to be specified: + ++-----+ +mvn help:describe -DgroupId=org.somewhere + -DartifactId=some-plugin -Dversion=0.0.0 ++-----+ + + or + ++-----+ +mvn help:active-profiles -Dplugin=org.somewhere:some-plugin:0.0.0 ++-----+ + + (NOTE: version is always optional here.) + +* The <<<help:effective-pom>>> Mojo + + The <<<effective-pom>>> mojo is used to make visible the POM that results from the application of interpolation, inheritance, + and active profiles. It provides a useful way of removing the guesswork about just what ends up in the POM that Maven uses + to build your project. It will iterate over all projects in the current build session, printing the effective POM for each. + + Optionally, the output parameter can be specified to divert this output to a file. + + The mojo can be executedd using the following command: + ++-----+ +mvn help:effective-profiles -Doutput=/path/to/file ++-----+ + +* The <<<help:effective-settings>>> Mojo + + The <<<effective-settings>>> mojo is used to view the Settings that Maven actually uses to run the build. This Settings + instance is a result of merging the global file with the user's file, with the user's file taking precedence. + + Optionally, the output parameter can be specified to divert this output to a file. + + The mojo can be executedd using the following command: + ++-----+ +mvn help:effective-settings -Doutput=/path/to/file ++-----+ + + Propchange: maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt ------------------------------------------------------------------------------ svn:eol-style = native Propchange: maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml ------------------------------------------------------------------------------ svn:eol-style = native