Author: brett
Date: Tue Jan 18 03:02:25 2005
New Revision: 125479

URL: http://svn.apache.org/viewcvs?view=rev&rev=125479
Log:
start doco
Added:
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/commontasks.xml
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/releasing.xml
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/scmurl.xml
Removed:
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml
Modified:
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml
   maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml

Added: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/commontasks.xml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/commontasks.xml?view=auto&rev=125479
==============================================================================
--- (empty file)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/commontasks.xml Tue Jan 
18 03:02:25 2005
@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+<!-- 
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ * 
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+  <properties>
+    <title>Common SCM Tasks</title>
+    <author email="[EMAIL PROTECTED]">Brett Porter</author>
+  </properties>
+
+  <body>
+    <section name="Common SCM Tasks">
+      <p>
+        The Maven SCM plugin allows you to perform some common SCM actions.
+      </p>
+      <subsection name="Checking out a project">
+        <p>
+          This command is usually performed without a project, as that is what 
you are
+          checking out, so you need to specify the <a href="scmurl.html">SCM 
URL</a>. The URL takes the same format
+          as the <code>&lt;repository&gt;&lt;connection&gt;</code> element in 
your <code>project.xml</code>
+          file.
+        </p>
+      </subsection>
+    </section>
+  </body>
+</document>
+

Deleted: /maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml?view=auto&rev=125478
==============================================================================

Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml?view=diff&rev=125479&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml&r1=125478&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml&r2=125479
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml       
(original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml       Tue Jan 
18 03:02:25 2005
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <!-- 
 /*
- * Copyright 2001-2004 The Apache Software Foundation.
+ * Copyright 2001-2005 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,16 +29,18 @@
       <p>
         A plugin for SCM tasks, currently CVS and Subversion.
       </p>
-      <p> 
-        For more information on the functionality provided by this plugin,
-        please see the
-        <a href="goals.html">Goals</a> document.
+      <p>
+        This documentation includes information on how to perform 
+        <a href="commontasks.html">common SCM tasks</a> and also
+        how to <a href="releasing.html">make project releases from SCM</a>.
       </p>
       <p>
-        For more information on how to customise the functionality provided
-        by this plugin, please see the
-        <a href="properties.html">properties</a>
-        document.
+        A reference on the <a href="scmurl.html">SCM URL format</a> is also 
included.
+      </p>
+      <p> 
+        For a full reference of this plugins capabilities,
+        please see the <a href="goals.html">Goals</a> and
+        <a href="properties.html">Properties</a> documents.
       </p>
     </section>
   </body>

Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml?view=diff&rev=125479&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml&r1=125478&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml&r2=125479
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml  
(original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/navigation.xml  Tue Jan 
18 03:02:25 2005
@@ -25,11 +25,14 @@
       <item href="http://maven.apache.org/"; name="Maven">
       </item>
     </links>
-    <menu name="Overview">
-      <item href="/goals.html" name="Goals">
-      </item>
-      <item href="/properties.html" name="Properties">
-      </item>
+    <menu name="User Guide">
+      <item href="/commontasks.html" name="Common Tasks" />
+      <item href="/releasing.html" name="Making Releases" />
+    </menu>
+    <menu name="Reference">
+      <item href="/scmurl.html" name="SCM URL Format" />
+      <item href="/goals.html" name="Goals" />
+      <item href="/properties.html" name="Properties" />
     </menu>
   </body>
 </project>

Added: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/releasing.xml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/releasing.xml?view=auto&rev=125479
==============================================================================
--- (empty file)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/releasing.xml   Tue Jan 
18 03:02:25 2005
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!-- 
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ * 
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+  <properties>
+    <title>Making Releases</title>
+    <author email="[EMAIL PROTECTED]">Brett Porter</author>
+  </properties>
+
+  <!-- TODO: move to main documentation -->
+  <body>
+    <section name="Making Releases from SCM">
+      <p>
+        TODO
+      </p>
+    </section>
+  </body>
+</document>
+

Added: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/scmurl.xml
Url: 
http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/scmurl.xml?view=auto&rev=125479
==============================================================================
--- (empty file)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/scmurl.xml      Tue Jan 
18 03:02:25 2005
@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+<!-- 
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ * 
+ * Licensed 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.
+ */
+ -->
+
+<document>
+
+  <properties>
+    <title>SCM URL Format</title>
+    <author email="[EMAIL PROTECTED]">Brett Porter</author>
+  </properties>
+
+  <!-- TODO: move to SCM documentation -->
+  <body>
+    <section name="SCM URL Format">
+      <p>
+        The SCM URL is used to provide any necessary information to connect to 
your
+        source control system.
+      </p>
+      <p>
+        The format is as follows:
+      </p>
+      <p>
+        ... Document incomplete ...
+      </p>
+    </section>
+  </body>
+</document>
+

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to