28 Nov
2007
28 Nov
'07
8:18 a.m.
Author: dreimer
Date: Wed Nov 28 11:18:51 2007
New Revision: 30832
URL: http://svn.reactos.org/svn/reactos?rev=30832&view=rev
Log:
Update Documentation (Part 1 of X).
Modified:
trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html
trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html
trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html
trunk/tools/RosBE/RosBE-Windows/Documentation/files/intro.html
Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html
URL:
http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Document…
==============================================================================
--- trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html (original)
+++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html Wed Nov 28 11:18:51 2007
@@ -1,12 +1,26 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <meta http-equiv="content-type" content="text/html;
charset=utf-8">
- <title>Advanced Features</title>
- <meta name="author" content="Daniel Reimer">
- <meta name="description" content="Lists the Advanced Features of
RosBE">
+ <meta http-equiv="content-type" content="text/html;
charset=utf-8">
+ <title>Advanced Features</title>
+ <meta name="author" content="Daniel Reimer">
+ <meta name="description"
+ content="Lists the Advanced Features of RosBE">
</head>
<body>
-<p>SVN 1.4.5 is included in RosBE. Manual can be found here:</p>
+<p>MinGW GCC 4.1.3 is included in RosBE. Manual can be found here: <a
+ href="http://www.mingw.org/">http://www.mingw.org/</a>and <a
+ href="http://gcc.gnu.org/">http://gcc.gnu.org</a><br&…
+Binutils 2.18.50 is included in RosBE. Manual can be found here: <a
+
href="http://www.gnu.org/software/binutils/">http://www.gnu.or…
+SVN 1.4.5 is included in RosBE. Manual can be found here: <a
+
href="http://subversion.tigris.org/">http://subversion.tigris.…
+CCache 2.4 is included in RosBE. Manual can be found here: <a
+
href="http://ccache.samba.org/">http://ccache.samba.org</a&…
+GDB 6.7.1 is included in RosBE. Manual can be found here: <a
+
href="http://www.gnu.org/software/gdb/">http://www.gnu.org/sof…
+NASM 2.00 is included in RosBE. Manual can be found here: <a
+
href="http://nasm.sourceforge.net/">http://nasm.sourceforge.ne…
+</p>
</body>
</html>
Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html
URL:
http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Document…
==============================================================================
--- trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html (original)
+++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html Wed Nov 28 11:18:51
2007
@@ -33,7 +33,8 @@
located in the RosBE directory, instructions for doing so are contained
within the file.</dd>
<dt>basedir</dt>
- <dd>Usage: basedir</dd>
+ <dd>Usage: basedir<br>
+ </dd>
<dd>Switches back to the ReactOS source directory.</dd>
<dt>chdefdir</dt>
<dd>Usage: chdefdir [OPTIONS]</dd>
@@ -42,10 +43,12 @@
Trees. Exiting RosBE sets back to the Default. </dd>
<dd>
<ul>
- <li> <dfn>default</dfn> - Sets back to the Default Source Folder
-without a restart of RosBE.</li>
+ <li> <dfn>previous </dfn>- Switch to the previous ReactOS
+source directory.</li>
</ul>
</dd>
+ <dt>chdefgcc [PATH]</dt>
+ <dd>Change the MinGW/GCC directory for the current RosBE session.</dd>
<dt>clean</dt>
<dd>Usage: clean [logs]</dd>
<dd> Fully cleans the ReactOS source directory and does a better job
@@ -68,7 +71,10 @@
<dd>
<ul>
<li> <dfn>delete</dfn> - Deletes the created configuration File
-and so sets back to default settings. </li>
+and so sets back to default settings.</li>
+ <li><span style="font-style: italic;">update</span> -
Deletes the
+old created configuration file and updates it with a new, default one.<br>
+ </li>
</ul>
</dd>
<dt>help</dt>
@@ -80,7 +86,7 @@
<dd> Starts the RosBE Configuration Program.<br>
</dd>
<dt>raddr2line</dt>
- <dd>Usage: raddr2line [OPTIONS]</dd>
+ <dd>Usage: raddr2line [FILE] [ADDRESS]</dd>
<dd> This Command translates program addresses of BSODs into file
names and line numbers of the Code it was built of to assist Developers
to find specific Bugs in ReactOS. This Tool is mainly a Dev Tool.
@@ -88,21 +94,24 @@
something. </dd>
<dd>
<ul>
- <li> <dfn>first parameter</dfn> - has to be the Executable to be
-analyzed. </li>
- <li> <dfn>second parameter</dfn> - has to be the address to be
-translated. If you don't set the needed Parameters, you will be asked
-for them. </li>
+ <li> <dfn>FILE</dfn> - This can be either a fully specified path
+or just the file name [you can use a partial name ie. ntdll*] of the
+executable to be analyzed. When using just a file the current directory
+and all sub-directories are searched.<dfn></dfn></li>
+ <li><dfn>ADDRESS</dfn> - The address to be translated.<br>
+ <dfn></dfn></li>
</ul>
</dd>
<dt>scut</dt>
<dd>Usage: scut [OPTIONS]</dd>
<dd>Defines, Edits, Removes, Switches and Defaults to Shortcutted
Source Directories. scut started without a parameter or with the name
-of a Shortcut as parameter sets this Shortcut active. </dd>
+of a Shortcut as parameter sets this Shortcut active.<br>
+ </dd>
<dd>
<ul>
- <li> <dfn>add</dfn> - Adds a Shortcut to a sourcecode.
</li>
+ <li> <dfn>list</dfn> - Lists all shortcuts and their paths.
<dfn></dfn></li>
+ <li><dfn>add</dfn> - Adds a Shortcut to a sourcecode.</li>
<li> <dfn>rem</dfn> - Deletes a specific shortcut. </li>
<li> <dfn>edit</dfn> - Lets you edit a specific shortcut.
</li>
<li> <dfn>def</dfn> - Chooses Default Shortcut which is enabled
Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html
URL:
http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Document…
==============================================================================
--- trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html (original)
+++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html Wed Nov 28 11:18:51
2007
@@ -1,21 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <meta http-equiv="content-type" content="text/html;
charset=utf-8">
- <title>Features</title>
- <meta content="Daniel Reimer" name="author">
- <meta content="Lists the Features of RosBE"
name="description">
+ <meta http-equiv="content-type" content="text/html;
charset=utf-8">
+ <title>Features</title>
+ <meta content="Daniel Reimer" name="author">
+ <meta content="Lists the Features of RosBE"
name="description">
</head>
<body>
- <ul>
- <li>Creating, Cleaning and Updating the Tree with included SVN and
sSVN.</li>
- <li>Building the Source (Multi Core Optimized)*</li>
- <li>Maintain Several Trees at once.</li>
- <li>Configure the Tree Settings with an easy to use editor.</li>
- <li>Help for Debugging, thanks to included GDB and raddr2line.</li>
- <li>Support for non Admin Rights Account.*</li>
- </ul>
-
- <p>* = This Feature is not supported under Windows Vista!</p>
+<ul>
+ <li>Creating, Cleaning and Updating the Tree with included SVN and
+sSVN.</li>
+ <li>Building the Source (Multi Core Optimized)</li>
+ <li>Maintain Several Trees at once.</li>
+ <li>Configure the Tree Settings with an easy to use editor.</li>
+ <li>Help for Debugging, thanks to included GDB and raddr2line.</li>
+ <li>Support for non Admin Rights Account.*</li>
+</ul>
+<p>* = This Feature is not supported under Windows Vista!</p>
</body>
</html>
Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/intro.html
URL:
http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Document…
==============================================================================
--- trunk/tools/RosBE/RosBE-Windows/Documentation/files/intro.html (original)
+++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/intro.html Wed Nov 28 11:18:51
2007
@@ -1,29 +1,41 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
- <meta http-equiv="content-type" content="text/html;
charset=utf-8">
- <title>Introduction</title>
- <meta name="author" content="Daniel Reimer">
- <meta name="description" content="Shows the Introduction to
RosBE">
+ <meta http-equiv="content-type" content="text/html;
charset=utf-8">
+ <title>Introduction</title>
+ <meta name="author" content="Daniel Reimer">
+ <meta name="description" content="Shows the Introduction to
RosBE">
</head>
<body>
<p>First of all, lets answer the main question: What is RosBE?<br>
-Its a Environment for building ReactOS on your own, its based on GCC 4.1.3
+Its a Environment for building ReactOS on your own, its based on GCC
+4.1.3
Compiler and aims to be the one and only Build Environment for absolute
Beginners up to skilled devs.</p>
-
<p>Realizing this wide spectrum in one BE is quite difficult of course.<br>
-How, as an example, do you tell a newbie how to use SVN or maintain/update a
+How, as an example, do you tell a newbie how to use SVN or
+maintain/update a
Source tree?<br>
-Easy. This package has the typical, well known SVN for all advanced devs and a
-slim Version specially made for newbies, called sSVN (Simple SVN), which only
-does the main stuff and has no difficult to understand or even dangerous, if
-wrong used, functions. Additionally it checks the working folder, if its empty
-or not. If its no empty folder, it does not even allow the User to continue.</p>
-
+Easy. This package has the typical, well known SVN for all advanced
+devs and a
+slim Version specially made for newbies, called sSVN (Simple SVN),
+which only
+does the main stuff and has no difficult to understand or even
+dangerous, if
+wrong used, functions. Additionally it checks the working folder, if
+its empty
+or not. If its no empty folder, it does not even allow the User to
+continue.</p>
<p>And this is just the beginning of a big list of features.<br>
Devs will be happy with the included GDB and raddr2line.<br>
-Multi Core PC Users will love "makex" which automatically detects the number
of
-CPU Cores and optimizes the Build process to that Number.</p>
+Multi Core PC Users will love "makex" which automatically detects the
+number of
+CPU Cores and optimizes the Build process to that Number.<br>
+Easy to maintain several trees by making Shortcuts to the paths with
+our tool, SCut.<br>
+Setting of a dozen of build parameters with a easy to understand
+Configurator App.<br>
+etc...<br>
+</p>
</body>
</html>