Adding some everest-sync documentation

2 files changed, 62 insertions, 7 deletions

diff --git a/everest-repo/everest-repo-1.0.0/docs/en-US/Cookbook.xml b/everest-repo/everest-repo-1.0.0/docs/en-US/Cookbook.xml
index 7bc8313..d37ebbe 100644
--- a/everest-repo/everest-repo-1.0.0/docs/en-US/Cookbook.xml
+++ b/everest-repo/everest-repo-1.0.0/docs/en-US/Cookbook.xml
@@ -162,16 +162,13 @@
 				 run:
 				
 				 <screen>
-everest-sync start quick --repo=[Remote Repo machine]
+# "reset --hard" to all the git repositories on a remote Repo
+everest-sync start quick --repo=[remote Repo machine]
+
+# Push all the repos where they need to go on the new Repo machine
 everest-sync save 
 				 </screen>
 			</para>
-
-			<para>
-				That will 'reset --hard' to all the git repos
-				that are on the remote Repo machine and then
-				copy the files where they need to go.
-			</para>
 	        </section>
 	</section>
 
diff --git a/everest-repo/everest-repo-1.0.0/docs/en-US/Tooling.xml b/everest-repo/everest-repo-1.0.0/docs/en-US/Tooling.xml
index 00a68bb..c18d987 100644
--- a/everest-repo/everest-repo-1.0.0/docs/en-US/Tooling.xml
+++ b/everest-repo/everest-repo-1.0.0/docs/en-US/Tooling.xml
@@ -17,12 +17,70 @@
 
 		<section id="everest-sync">
 			<title>everest-sync</title>
+			<para>
+				The goal of
+				<application>everest-sync</application> is to
+				make the process of syncronizing git
+				repositories from one &PRODUCT; Repo to another
+				as easy as possible.  The main mode
+				<emphasis>start</emphasis> which guides the
+				user through the process.  
+			</para>
+
+			<para> 
+				In the <emphasis>start</emphasis> mode work
+				will be performed in a working directory.  The
+				app will then iterate over each repository,
+				asking the user what work to perform.
+			</para>
 
 			<section id="everest-sync-usage">
 				<title>Usage</title>
 				<para>
+					The following oneliners are in no particular order.
+					<screen>
+# Start the syncronization wizard
+everest-sync start --repo=[remote Repo machine]
+					</screen>
+
+					<screen>
+# Hard reset to a given repositories state
+everest-sync start quick --repo=[remote Repo machine]
+					</screen>
+
+					<screen>
+# Push content where it needs to go 
+everest-sync save
+					</screen>
+
+					<screen>
+# Remove the working directory  
+everest-sync clean
+					</screen>
 					
 				</para>
+				<important>
+					<title>Important</title>
+					<para>
+						<application>everest-sync</application>
+						must be run as the
+						<emphasis>everest</emphasis>
+						user.
+					</para>
+				</important>
+
+				<note>
+					<title>Note</title>
+					<para>
+						All
+						<application>everest-sync</application>
+						modes take the
+						<emphasis>--help</emphasis>,
+						<emphasis>--verbose</emphasis> and
+						<emphasis>--workingdir</emphasis>
+						flags.
+					</para>
+				</note>
 			</section>
 		</section>
 	</section>