Author: olamy
Date: Sat Nov 26 23:41:16 2011
New Revision: 1206634
URL: http://svn.apache.org/viewvc?rev=1206634&view=rev
Log:
start adding documentation
Added:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
(with props)
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
(with props)
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
(with props)
Added:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt?rev=1206634&view=auto
==============================================================================
---
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
(added)
+++
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
Sat Nov 26 23:41:16 2011
@@ -0,0 +1,41 @@
+ ------
+ Introduction
+ ------
+ Olivier Lamy
+ ------
+ 2011-11-26
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Maven Patch Tracker Plugin
+
+ This plugin provides the capability to act with your issue/patch tracker to
create patchs/issues for your project.
+
+* Goals Overview
+
+ * {{{./create-mojo.html}patch-tracker:create}} generate a patch from the
project and create an entry in a patch tracker.
+
+ * {{{./update-mojo.html}patch-tracker:update}} generate a patch from the
project and update an entry in a patch tracker.
+
+ * {{{./to-issue-mojo.html}patch-tracker:to-issue}} transform your patch
tracker entry to an issue in your issue tracker.
+
+ []
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm?rev=1206634&view=auto
==============================================================================
---
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
(added)
+++
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
Sat Nov 26 23:41:16 2011
@@ -0,0 +1,64 @@
+ ------
+ Usage
+ ------
+ Olivier Lamy
+ ------
+ 2011-11-26
+ ------
+
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements. See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership. The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License. You may obtain a copy of the License at
+ ~~
+ ~~ http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied. See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html
+
+Usage
+
+ Some brief examples on how to use this plugin.
+
+* Generate a diff from the project and load the issue to a new (or update)
issue in your issue tracker.
+
+ All scm supported by {{{http://maven.apache.org/scm}Apache Maven Scm}} are
supported for generate a diff/patch.
+
+ <<Note>>: The only target supported system is jira. (feature to come:
reviewboard)
+
+ Most of the parameters can be configured in the mojo or with cli (see below
for easy configuration).
+
+ <<Note>>: if you don't use non interactive mode (-B), Maven will ask you
some questions.
+
+ So hack on the project and simply use :
+
++---------
+mvn patch-tracker:create -Dpatch.summary="foo summary" -B
+// the scm declared in the pom is svn but you use git svn add the parameter
+mvn patch-tracker:create -Dpatch.summary="foo summary" -B
-Dscm.providerType=git
++---------
+
+* Create an issue from a patch tracker.
+
+ Get a patch/diff from your patch tracker system.
+
+ <<Note>>: The only supported is github. (feature to come: reviewboard)
+
+ So the plugin will simply read a pull request a create an issue in your
issue tracker.
+
+ <<Note>>: The only supported issue tracker is jira.
+
+* Easy configuration setup (save your fingers!)
+
+ By default if non using non interactive Maven mode (-B cli option), this
plugin will ask you some questions.
+
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/apt/usage.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml?rev=1206634&view=auto
==============================================================================
--- maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
(added)
+++ maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
Sat Nov 26 23:41:16 2011
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0
http://maven.apache.org/xsd/decoration-1.0.0.xsd";
+ name="Maven Patch Tracker plugin">
+ <body>
+ <menu name="Overview">
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ </menu>
+
+ </body>
+</project>
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/sandbox/trunk/plugins/maven-patch-tracker-plugin/src/site/site.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
