directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject directory-fortress-core git commit: FC-84 - Add console and cli instructions to doc
Date Wed, 25 Mar 2015 13:23:42 GMT
Repository: directory-fortress-core
Updated Branches:
  refs/heads/master 9b844eb0d -> 2d6e1e9f2


FC-84 - Add console and cli instructions to doc


Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/2d6e1e9f
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/2d6e1e9f
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/2d6e1e9f

Branch: refs/heads/master
Commit: 2d6e1e9f2b0a2efb536ff03a8c3f0ae23e82e618
Parents: 9b844eb
Author: Shawn McKinney <smckinney@apache.org>
Authored: Wed Mar 25 08:23:29 2015 -0500
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Wed Mar 25 08:23:29 2015 -0500

----------------------------------------------------------------------
 README.txt                                      | 33 +++++++++-----------
 .../core/doc-files/apache-fortress-core.html    | 24 ++++++++++++++
 .../core/doc-files/ten-minute-guide.html        | 18 -----------
 3 files changed, 39 insertions(+), 36 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/2d6e1e9f/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index a7f5371..c525b35 100755
--- a/README.txt
+++ b/README.txt
@@ -66,17 +66,12 @@ ________________________________________________________________________________
  - Fortress Core package operations originally were designed to work using Ant.  Today, these
same operations are being moved into
    the maven pom.xml.  Both still work, but ant is being phased out.
 
- - This software packages preferred means to build and install uses Apache Maven (script
FORTRESS_HOME/pom.xml) - Sections 3,8,13
+ - This software packages preferred means to build and install uses Apache Maven (script
FORTRESS_HOME/pom.xml)
 
- - This software package still uses Apache Ant (script FORTRESS_HOME/build.xml) for many
utility functions listed in this README - Sections 6,7,9-12.
+ - This software package still uses Apache Ant (script FORTRESS_HOME/build.xml) for some
functions, i.e. slapd configuration, listed in Sections 4,6,7.
 
  - The targets may be used to the fortress security policy data contained within an existing
LDAP server.
 
- - This document describes the most important targets to start using fortress.  For a complete
list, enter (from FORTRESS_HOME):
-   $ANT_HOME/bin/ant -p
-
- - Or view the maven script (FORTRESS_HOME/pom.xml) and ant script (FORTRESS_HOME/build.xml).
-
  - Questions pertaining to usage of this software may be submitted to:
     http://mail-archives.apache.org/mod_mbox/directory-fortress/
 
@@ -522,11 +517,13 @@ ________________________________________________________________________________
 
 a. from FORTRESS_HOME enter the following command:
 
-# $ANT_HOME/bin/ant cli
+# $M2_HOME/bin/mvn -Pcli test
 
 b. follow instructions in the command line interpreter reference manual contained within
the javadoc:
 
-$FORTRESS_HOME/dist/docs/api/com/jts/fortress/cli/package-summary.html
+   file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/cli/package-summary.html
+
+   (where [directory-fortress-core] is location of current source package)
 
 ___________________________________________________________________________________
 ###################################################################################
@@ -555,21 +552,21 @@ ________________________________________________________________________________
 
 a. from FORTRESS_HOME enter the following command:
 
-# $ANT_HOME/bin/ant test-samples
+# $M2_HOME/bin/mvn -Dtest=AllSamplesJUnitTest test
 
-c. view and change the samples here:
+b. view and change the samples here:
 
 $FORTRESS_HOME/src/test/com/jts/fortress/samples
 
-d. compile and re-run samples to test your changes using:
+c. compile and re-run samples to test your changes using:
 
-# $ANT_HOME/bin/ant test-samples
+# $M2_HOME/bin/mvn -Dtest=AllSamplesJUnitTest test
 
-e. view the samples java doc here:
+d. view the samples java doc here:
 
 $FORTRESS_HOME/dist/docs/samples/index.html
 
-f. view the fortress-core SDK java doc here:
+e. view the fortress-core SDK java doc here:
 
 $FORTRESS_HOME/dist/docs/api/index.html
 
@@ -581,9 +578,9 @@ Testing Notes:
 
   - These tests will load some records into the target ldap server.
 
-  - The 'test-samples' target may be run as many times as necessary and should be run at
least twice to test the teardown A/P/R/BAC APIs.
+  - The target may be run as many times as necessary and should be run at least twice to
test the teardown A/P/R/BAC APIs.
 
-  - The 2nd and subsequent times 'test-samples' runs, it will tear down the data loaded during
the prior run.
+  - The 2nd and subsequent times runs, it will tear down the data loaded during the prior
run.
 
 ___________________________________________________________________________________
 ###################################################################################
@@ -592,7 +589,7 @@ ________________________________________________________________________________
 
 a. from FORTRESS_HOME enter the following command:
 
-# $ANT_HOME/bin/ant console
+# $M2_HOME/bin/mvn -Pconsole test
 
 ___________________________________________________________________________________
 ###################################################################################

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/2d6e1e9f/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
index edd7c36..0ec3798 100755
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/apache-fortress-core.html
@@ -169,6 +169,30 @@ mvn -Dtest=FortressJUnitTest test
                 </pre>
         Tests should run with no errors.
     </li>
+
+    <li>
+        Run the Fortress Command Line Interface:
+                <pre>
+                    <p style="font: monospace; color: black; background-color: lightgrey;
font-size: 10pt">
+mvn -Pcli test
+                    </p>
+                </pre>
+For instructions on how to use CLI, point your browser here:
+        <br>file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/cli/package-summary.html.
+        <br><br>Where [directory-fortress-core] is base folder of the fortress
core source package.
+    </li>
+
+    <br>
+    
+    <li>
+        Run the Fortress Console:
+                <pre>
+                    <p style="font: monospace; color: black; background-color: lightgrey;
font-size: 10pt">
+mvn -Pconsole test
+                    </p>
+                </pre>
+    </li>
+
 </ol>
 </body>
 <p style="font: monospace; color: black; font-size: 6pt">Copyright 2003-2015, The Apache
Software Foundation. All Rights

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/2d6e1e9f/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
index 5cafe18..57b3cf5 100644
--- a/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
+++ b/src/main/java/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html
@@ -112,24 +112,6 @@ mvn javadoc:javadoc
                 </pre>
     </li>
 
-    <!--plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>${javadoc.version}</version>
-        <configuration>
-            <additionalparam>-Xdoclint:none</additionalparam>
-            <stylesheet>java</stylesheet>
-            <bottom>&lt;small&gt;Copyright &amp;copy; 2003-2015, The Apache
Software Foundation. All Rights Reserved. Generated ${maven.build.timestamp}&lt;/small&gt;</bottom>
-            <overview>src/main/java/org/apache/directory/fortress/core/overview.html</overview>
-            <docfilessubdirs>true</docfilessubdirs>
-            <includes></includes>
-            <version>true</version>
-            <author>true</author>
-            <doctitle>Fortress Identity and Access Management Javadoc ${version}</doctitle>
-            <windowtitle>Apache Fortress Identity and Access Management Javadoc ${version}</windowtitle>
-        </confsiguration>
-    </plugin-->
-
     <li>Point your web browser to the javadoc:
         <br>file:///[directory-fortress-core]/target/site/apidocs/org/apache/directory/fortress/core/doc-files/ten-minute-guide.html.
         <br><br>Where [directory-fortress-core] is base folder of the fortress
core source package.


Mime
View raw message