svn commit: r368519 - /maven/maven-1/plugins/trunk/jira/xdocs/faq.fml

[lt...@apache.org]

Author: ltheussl
Date: Thu Jan 12 15:54:06 2006
New Revision: 368519

URL: http://svn.apache.org/viewcvs?rev=368519&view=rev
Log:
Update docs

Modified:
    maven/maven-1/plugins/trunk/jira/xdocs/faq.fml

Modified: maven/maven-1/plugins/trunk/jira/xdocs/faq.fml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/jira/xdocs/faq.fml?rev=368519&r1=368518&r2=368519&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/jira/xdocs/faq.fml (original)
+++ maven/maven-1/plugins/trunk/jira/xdocs/faq.fml Thu Jan 12 15:54:06 2006
@@ -28,12 +28,19 @@
       </question>
       <answer>
         <p>
-          1. modify/double check that your project.xml has issue tracking url in the following format :
+          1. The jira plugin needs the jira id number of your project to work. Preferably,
+          your project.xml should have an <code>&lt;issueTrackingUrl&gt;</code> in the following format :
         </p>
         <source>&lt;issueTrackingUrl&gt;[JIRA URL]/BrowseProject.jspa?id=[JIRA PROJECT ID]&lt;/issueTrackingUrl&gt;</source>
         <p>Example :</p>
         <source>&lt;issueTrackingUrl&gt;http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450&lt;/issueTrackingUrl&gt;</source>
-        
+        <p>
+          If no id is found in <code>&lt;issueTrackingUrl&gt;</code>, like eg, in
+        </p>
+        <source>&lt;issueTrackingUrl&gt;http://jira.codehaus.org/browse/MPJIRA&lt;/issueTrackingUrl&gt;</source>
+        <p>
+          an attempt is made to extract the id from the jira project page, but this is not guaranteed to work.
+        </p>
         <p>
           2. Determine the credentials to log into the webserver, if any. The plugin supports basic authentication (and SSL). 
           Add the credentials to the project.properties, as maven.jira.webUser and maven.jira.webPassword