[Gearbox-commit] SF.net SVN: gearbox: [49] gearbox/trunk/doc

[<rus...@us...>]

Revision: 49
          http://gearbox.svn.sourceforge.net/gearbox/?rev=49&view=rev
Author:   russo2503v
Date:     2008-02-07 22:53:36 -0800 (Thu, 07 Feb 2008)

Log Message:
-----------
uppded required cmake version to 2.4.4

Modified Paths:
--------------
    gearbox/trunk/doc/getting.dox
    gearbox/trunk/doc/install_debian.dox
    gearbox/trunk/doc/overview.dox

Modified: gearbox/trunk/doc/getting.dox
===================================================================
--- gearbox/trunk/doc/getting.dox	2008-02-08 06:35:49 UTC (rev 48)
+++ gearbox/trunk/doc/getting.dox	2008-02-08 06:53:36 UTC (rev 49)
@@ -21,14 +21,10 @@
 - Option 1. Download <strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468" style="text-decoration:none">the latest distribution of GearBox</a></strong>
 
 - Option 2. Checkout source from SVN
-    - Anonymous checkout:
+    - Anonymous checkout (your username/password will be asked on commit):
 @verbatim
 $ svn co https://gearbox.svn.sf.net/svnroot/gearbox/gearbox/trunk gearbox
 @endverbatim
-    - Checkout for registered developers:
-@verbatim
-$ svn co --username [your-sf-username] https://gearbox.svn.sf.net/svnroot/gearbox/gearbox/trunk gearbox
-@endverbatim
     - See links @ref gbx_doc_version_control "to get started" with SVN.
     - See <strong><a href="http://sourceforge.net/svn/?group_id=216468" style="text-decoration:none">more detailed SourceForge SVN instructions.</a></strong>
 
@@ -42,7 +38,7 @@
 The instructions below are quite general, follow them if your platform/distribution combination is not described above:
 
     -# Download and install <a href="http://www.cmake.org/">CMake: Cross-Platform Make</a> which is used to build the GearBox distribution.
-    - Minimum version required 2.4-patch 2 (latest tested: 2.4-patch 7).
+    - Minimum version required 2.4-patch 4 (latest tested: 2.4-patch 7).
         - Full instructions are available from the <a href="http://www.cmake.org/HTML/Download.html">download page</a>.
     -# Download and install any optional dependencies you'd like. Or just skip this step and do it later.
         - You may want to take a look at our notes on @ref gbx_doc_depends.

Modified: gearbox/trunk/doc/install_debian.dox
===================================================================
--- gearbox/trunk/doc/install_debian.dox	2008-02-08 06:35:49 UTC (rev 48)
+++ gearbox/trunk/doc/install_debian.dox	2008-02-08 06:53:36 UTC (rev 49)
@@ -20,15 +20,9 @@
 
 These instructions should also be applicable to Ubuntu/Kubuntu 6.10 (Edgy).
 
-@section gbx_doc_installdebian_buildessential Build Essential
-
-@verbatim
-# apt-get install build-essential
-@endverbatim
-
 @section gbx_doc_installdebian_cmake CMake
 
-Minimum version required 2.4-patch 2 (latest tested: 2.4-patch 7).
+Minimum version required 2.4-patch 4 (latest tested: 2.4-patch 7).
 
 @verbatim
 # apt-get install cmake
@@ -42,10 +36,10 @@
 
 - Download @ref gbx_doc_getting_download "GearBox source" archive and un-tar it.
 @verbatim
-$ tar -zxf gearbox-x.x.x.tar.gz
+$ tar -xzf gearbox-x.x.x.tar.gz
 $ cd gearbox
 @endverbatim
-- Configure (note the dot after cmake). The default installation directory is  @c /usr/local. (See below on how to customize it).
+- Configure (note the dot after cmake). The default installation directory is  @c /usr/local. (See below on how to customize this).
 @verbatim
 $ cmake .
 @endverbatim
@@ -74,7 +68,7 @@
 @par Installation Directory
 
 The default installation directory is @c /usr/local. There are two options for specifying a custom install directory:
-- Option 1. With @c cmake. This variable is stored in CMake cache so you don't have to set this variable every time: only the first time you run cmake and when you want to change it.
+- Option 1. With @c cmake. This variable is stored in CMake cache so you don't have to set this variable every time: only the first time you run cmake and when you want to change it. For example:
 @verbatim
 $ cmake -DCMAKE_INSTALL_PREFIX=$HOME/gearbox .
 @endverbatim
@@ -86,7 +80,7 @@
 @verbatim
 $ ccmake .
 @endverbatim
-Scroll down to  CMAKE_INSTALL_PREFIX variable, hit ENTER to edit and type in the new installation directory. When finished, hit ENTER again, then type "c" for [c]onfigure and "g" for [g]enerate. From now on, the new installation dir will be used.
+Scroll down to @c CMAKE_INSTALL_PREFIX variable, hit ENTER to edit and type in the new installation directory. When finished, hit ENTER again, then type "c" for [c]onfigure and "g" for [g]enerate. From now on, the new installation dir will be used.
 
 That's it! We are done.
 

Modified: gearbox/trunk/doc/overview.dox
===================================================================
--- gearbox/trunk/doc/overview.dox	2008-02-08 06:35:49 UTC (rev 48)
+++ gearbox/trunk/doc/overview.dox	2008-02-08 06:53:36 UTC (rev 49)
@@ -28,9 +28,9 @@
 
 Copyright belongs to developers and major contributors. The copyright is recorded in a comment block at the top of every source file.
 
-@par Complete Description of Rules
+@par Details
 
-For a complete set of project rules see @ref gbx_doc_principles
+For more details see @ref gbx_doc_principles
 
 @par OS support
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.