incubator-depot-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickcha...@apache.org
Subject svn commit: rev 6863 - in incubator/depot/trunk/ruper/src/documentation/content/xdocs: . ant eclipse
Date Thu, 26 Feb 2004 07:26:23 GMT
Author: nickchalko
Date: Wed Feb 25 23:26:23 2004
New Revision: 6863

Modified:
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/reposync.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/repotool.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/eclipse/index.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/faq.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/index.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/overview.xml
   incubator/depot/trunk/ruper/src/documentation/content/xdocs/tabs.xml
Log:
More doc updates from Nicola

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/reposync.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/reposync.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/reposync.xml	Wed Feb 25
23:26:23 2004
@@ -27,5 +27,10 @@
  		<title>Parameters specified as text content</title>
 		<p>None</p> 
 	</section>
+	<section><title>Cut-n-Paste - Synchronize with Repositories</title>		
+		<p>Keep this group up to date with that in repositories.</p>
+		<source>&lt;reposync group="junit"&gt;</source>
+	</section>
+        
   </body>
 </document>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/repotool.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/repotool.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/ant/repotool.xml	Wed Feb 25
23:26:23 2004
@@ -27,5 +27,9 @@
  		<title>Parameters specified as text content</title>
 		<p>None</p> 
 	</section>
+	<section><title>Cut-n-Paste - List a Group in all Repositories</title>
	
+		<p>Log the contents of the group.</p>
+		<source>&lt;repotool group="junit"&gt;</source>
+	</section>
   </body>
 </document>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/eclipse/index.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/eclipse/index.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/eclipse/index.xml	Wed Feb
25 23:26:23 2004
@@ -18,13 +18,13 @@
       <section><title>Repositories</title>
       	<p>All configured repositories are available for view.</p>
       	<p>
-      		<img alt="Repository Seelection" src="../graphics/Repositories.jpg"/>
+      		<img alt="Repository Seelection" src="repositories.jpg"/>
       	</p>
       </section>
       <section><title>Browsing</title>
       	<p>A repositories contents can be introspected.</p>
       	<p>	
-      		<img alt="Repository Browsing" src="../graphics/Browser.jpg"/>
+      		<img alt="Repository Browsing" src="browser.jpg"/>
       	</p>
       </section>
     </section>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/faq.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/faq.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/faq.xml	Wed Feb 25 23:26:23
2004
@@ -1,15 +1,29 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
+<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V1.2//EN" "dtd/faq-v12.dtd">
 
-<document>
-  <header>
-    <title>Apache-Ruper Ant Tasks - FAQ</title>
-    <authors>
-      <person id="arb_jack" name="Adam R. B. Jack" email="arb_jack@users.sourceforge.net"/>
-    </authors>
-  </header>
-  
-  <body>
-  	<note>Ask and they'll be added...</note>
-  </body>
-</document>
+<faqs title="Frequently Asked Questions">
+
+  <part id="ant_tasks">
+    <title>Ant Tasks</title>
+    <faq id="defining_ruper_anttasks">
+      <question>How do I define these tasks to ant?</question>
+       <answer>
+    		<p>Use:</p>
+    			<source>&lt;taskdef resource="apache-ruper"&gt;</source>
+    		<p>Basically this looks for a file called 'apache-ruper' in the classpath, and
hopefully finds it in
+    			the Apache-Ruper JAR. That is a simple text file that defines the various tasks to
ant.
+    			</p>
+    			<note>Apache-Ruper must be in your classpath, and available to be loaded.</note>
+     </answer>
+    </faq>
+    <faq id="how_to_start_using_ruper_anttasks">
+      <question>These ant tasks have so many parameters, how do I know what I need?</question>
+       <answer><p>Although the tasks do have a lot of flexibility they are intended
primarily for simple usage (with just a few parameters) and
+    			allow you to tweak things. Try what makes common sense and let the task tell you if
it needs
+    			more. If you feel something is non-intuitative let us know, we'll look into it.</p>
+<note>See <link href="cut-n-paste.html">cut-n-paste section</link> for
examples.</note>
+     </answer>
+    </faq>
+    
+  </part>
+</faqs>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/index.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/index.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/index.xml	Wed Feb 25 23:26:23
2004
@@ -8,18 +8,25 @@
     <section>
       <title>Resource Updater</title>
       <p>Apache-Ruper is a resource updater, 
-      	meaning it <strong>automatically</strong> keeps local resources up-to-date
with versions of the resource found in repositories.</p>
-      	<p>Say you have a build script that uses releases of certain jars, e.g. junit.jar
or commons-logging.jar, you could ask Ruper to get the latest <strong>release</strong>
of these, and store it in your <code>./lib</code> directory. 
-      		Alternatively, you could create a shared <code>$HOME/jars</code> directory
(say) so all your build scripts share the latest release.</p>
-      		
-      <p>For more information, ask the <fork href="http://apache.org/wiki/Ruper2">Wiki</fork>
and also as it about history on <fork href="http://apache.org/wiki/Ruper">Ruper1</fork>.</p>
-    </section>
+      	meaning it <strong>automatically</strong> keeps local resources up-to-date
with 
+      	versions of the resource found in repositories.</p>
+      	<p>Say you have a build script that uses releases of certain jars, e.g. junit.jar

+      	   or commons-logging.jar, you could ask Ruper to get the latest <strong>release</strong>

+      	   of these, and store it in your <code>./lib</code> directory. 
+           Alternatively, you could create a shared <code>$HOME/jars</code> directory
(say) 
+      	  so all your build scripts share the latest release.</p>
+      	  
+       </section>
     
     <section><title>Why Ruper was created...</title>
-    	<p>Apache-Ruper was developed as a middle ground between <fork href="http://ant.apache.org/manual/CoreTasks/get.html">Ant
&lt;get</fork> (to download a certain 'stale' version of a jar) and the relative
chaos of <fork href="http://jakarta.apache.org/gump">Jakarta Gump</fork> (which
gets/build the absolute latest ever time).  
+    	<p>Apache-Ruper was developed as a middle ground between 
+    	  <link href="http://ant.apache.org/manual/CoreTasks/get.html">Ant &lt;get&gt;</link>

+    	    (to download a certain 'stale' version of a jar) and the relative chaos of 
+    	     <link href="http://jakarta.apache.org/gump">Gump</link> (which gets/build
the absolute latest ever time).  
     	</p>
+<p>
+An example of a 'potentially stale' update (version is hard coded.)</p>
 <source>
-An example of a 'potentially stale' update (version is hard coded.)
     		
 &lt;get src=&quot;http://www.ibiblio.org/maven/commons-logging/jars/commons-logging-1.0.jar&quot;

     	dest=&quot;${lib}/commons-logging.jar&quot; 
@@ -27,16 +34,24 @@
 		verbose=&quot;true&quot;/&gt;
 </source>
     	<p>
-    		Apache Ruper performs as a 'negotiation' between the (remote) repository populators
and the (local) builder. 
+    		Ruper performs as a 'negotiation' between the (remote) repository populators and the
(local) builder. 
     		For example, a new 'release candiate' of a JAR could be published. 
     		Typically Ruper would download it, but it could be asked to not do so, and only download
'release' level code.
     		</p>
     		
     		<p>Ruper <strong>trusts the repository manager, but answers to the builder</strong>
so allows a blend.</p>
     	
-    	<p>Apache-Ruper helps reduce <fork href="http://apache.org/version/jar-hell">JAR
HELL</fork> by reducing stagnant code compiling/testing. 
+    	<p>Ruper helps reduce <link href="jar-hell">JAR HELL</link> by reducing
stagnant code compiling/testing. 
     		The more projects that work of "out of date" code, the more chance that combining those
projects in a single runtime environment
     		will suffer irrepairable jar-hell through incompatibilities.</p>
+        	<note>Depot Ruper is an effort undergoing incubation at the Apache Software
Foundation (ASF), 
+    	      sponsored by the Incubator PMC. Incubation is required of all newly accepted projects

+    	      until a further review indicates that the infrastructure, communications, and
decision
+    	       making process have stabilized in a manner consistent with other successful ASF
projects. 
+    	       While incubation status is not necessarily a reflection of the completeness or
stability 
+    	       of the code, it does indicate that the project has yet to be fully endorsed by
the ASF.
+    	</note>	
     </section>
+   	
   </body>
 </document>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/overview.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/overview.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/overview.xml	Wed Feb 25 23:26:23
2004
@@ -4,26 +4,16 @@
 <document>
   <header>
     <title>Apache-Ruper Overview</title>
-    <authors>
-      <person id="arb_jack" name="Adam R. B. Jack" email="arb_jack@users.sourceforge.net"/>
-     </authors>
   </header>
   
   <body>
-    	<section><title>Apache-Ruper Definitions</title>
+    	<section><title>Definitions</title>
     		<p>Ruper introduces terminology for the participants in it's worldview.</p>
-    	</section>
-    	
-    	<section><title>Resource</title>
-    		<p>A named item (a file of sorts)</p>
-    	</section>
-    	
-    	<section><title>Repository</title>
-    		<p>A repository object contains resources</p>
-    	</section>
-
-    	<section><title>Instance of Resource</title>
-    		<p>E.g. X-01012003.jar is an instance of the X resource.</p>
+            <ul>
+              <li><strong>Resource:</strong> A named item (a file of sorts)</li>
+              <li><strong>Repository:</strong> A repository object contains
resources</li>
+              <li><strong>Instance of Resource:</strong> E.g. X-01012003.jar
is an instance of the X resource</li>
+            </ul>  
     	</section>
 
   </body>

Modified: incubator/depot/trunk/ruper/src/documentation/content/xdocs/tabs.xml
==============================================================================
--- incubator/depot/trunk/ruper/src/documentation/content/xdocs/tabs.xml	(original)
+++ incubator/depot/trunk/ruper/src/documentation/content/xdocs/tabs.xml	Wed Feb 25 23:26:23
2004
@@ -6,10 +6,9 @@
       copyright="2002-@year@ Apache Project"
       xmlns:xlink="http://www.w3.org/1999/xlink">
 
-        <tab label="Home" dir=""/>
-		<tab label="Config" dir="config"/>
-		<tab label="Tools" dir="tool"/>
-		<tab label="Ant Tasks" dir="ant"/>
-        <tab label="Eclipse" dir="eclipse" />
-        <tab label="API" dir="api" />
+        <tab label="Community" id="community" dir=""  indexfile="changes.html"/>
+        <tab label="Project" id="project" dir=""/>
+        <tab label="Docs" id="docs" dir=""  indexfile="overview.html"/>
+        <tab label="Code" id="code" href="http://cvs.apache.org/viewcvs.cgi/incubator/depot/trunk/ruper/?root=Apache-SVN"
/>
+        
 </tabs>

Mime
View raw message