From dreimer@svn.reactos.org Sat Jan 24 17:04:50 2009 From: dreimer@svn.reactos.org To: ros-diffs@reactos.org Subject: [ros-diffs] [dreimer] 39062: Update Documentation of RosBE. Date: Sat, 24 Jan 2009 14:46:21 +0000 Message-ID: <20090124160447.DFC0198974@mail.reactos.org> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============1063497374495259521==" --===============1063497374495259521== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Author: dreimer Date: Sat Jan 24 08:46:21 2009 New Revision: 39062 URL: http://svn.reactos.org/svn/reactos?rev=3D39062&view=3Drev Log: Update Documentation of RosBE. 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/config.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/credits.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/howto.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/intro.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/main.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/menu.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/options.html trunk/tools/RosBE/RosBE-Windows/Documentation/files/options.jpg trunk/tools/RosBE/RosBE-Windows/Documentation/files/top.html trunk/tools/RosBE/RosBE-Windows/Powershell/Help.ps1 trunk/tools/RosBE/RosBE-Windows/Root/Config.cmd trunk/tools/RosBE/RosBE-Windows/Root/Help.cmd Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/adv.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html [iso-8859-1]= (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/adv.html [iso-8859-1]= Sat Jan 24 08:46:21 2009 @@ -1,25 +1,25 @@ - + Advanced Features + content=3D"Lists the Advanced Features of RosBE.">

MinGW GCC 4.1.3 is included in RosBE. Manual can be found here: http://www.mingw.org/and http://gcc.gnu.org
-Binutils 2.18.50 is included in RosBE. Manual can be found here: http://www.gnu.org/software/= binutils
-SVN 1.4.5 is included in RosBE. Manual can be found here: http://subversion.tigris.org
CCache 2.4 is included in RosBE. Manual can be found here: http://ccache.samba.org
-GDB 6.7.1 is included in RosBE. Manual can be found here: http://www.gnu.org/software/gdb
-NASM 2.00 is included in RosBE. Manual can be found here:
http://nasm.sourceforge.net

Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/basic.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html [iso-8859-= 1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/basic.html [iso-8859-= 1] Sat Jan 24 08:46:21 2009 @@ -1,42 +1,119 @@ - + Basic Features - +
make
+
+
Usage: make [OPTIONS]
-
-
The command to build the ReactOS Source Tree in the Default -directory.
-Without options it does a standard build of ReactOS. OPTIONS are the -standard ReactOS build options ie.
-
- -
+Make does a standard build of ReactOS. OPTIONS are the standard ReactOS +build options: +
+ +
+
+
makex
+
+
Usage: makex [OPTIONS]
-
-
Same as 'make' but automatically determines the number of CPU -Cores in your system and uses "make -j x" with the appropriate number -to threaden the build process for a massive speedup on Multi Core -Systems.
-NOTE: The number makex uses can be modified by editing Build-Multi.cmd -located in the RosBE directory, instructions for doing so are contained -within the file.
-
basedir
+Same as 'make' but automatically determines the number of CPU Cores in +the system and uses "make -j x" with the appropriate number. OPTIONS +are the standard ReactOS build +options:
+ +
+ +
+
+
+basedir +
Usage: basedir
Switches back to the ReactOS source directory.
+
+charch +
+
Usage: charch [OPTIONS]
+Change the Architecture to build ReactOS for, for the current RosBE +session. Possible Architectures are: i386, ppc, arm, amd64.
+
+
+
chdefdir
+

+
Usage: chdefdir [OPTIONS]
Reconfigures the Default Source Folder for one Session. This is useful for switching between branches or different ReactOS Source @@ -47,9 +124,24 @@ source directory.
+

+
chdefgcc [PATH]
+

+
Change the MinGW/GCC directory for the current RosBE session.
+
+ +
clean
+

+
Usage: clean [logs]
Fully cleans the ReactOS source directory and does a better job than "make clean" does.
@@ -58,11 +150,19 @@ and 1:1 like a fresh loaded one.
-
+
  • all - Removes +build logs and compiler output in the RosBE-Logs directory.
  • +
  • logs - Removes all build logs in the RosBE-Logs +directory.
  • + +All other commands will be parsed as "make COMMAND_clean" and cleans +the specific command.
    + +
    +
    config
    +

    +
    Usage: config [OPTIONS]
    This Command creates a Configuration File, which tells RosBE how to build the Tree. There are many things you can modify in the build @@ -76,19 +176,29 @@
  • delete - Deletes the created configuration File and so sets back to default settings.
  • update - Deletes the -old created configuration file and updates it with a new, default one.
    -
  • - +old created configuration file and updates it with a new, default one. + +
    help
    +

    +
    Usage: help [COMMAND]
    Shows help for the specified command or lists all available commands.
    +

    +
    options
    +

    +
    Usage: options
    -
    Starts the RosBE Configuration Program.
    -
    +
    Starts the RosBE Configuration Program and sets the changes +active in the cureent session.
    +

    +
    raddr2line
    +

    +
    Usage: raddr2line [FILE] [ADDRESS]
    This Command translates program addresses of BSODs into file names and line numbers of the Code it was built of to assist Developers @@ -101,11 +211,13 @@ 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. -
  • ADDRESS - The address to be translated.
    -
  • - +
  • ADDRESS - The address to be translated.
  • + +
    scut
    +

    +
    Usage: scut [OPTIONS]
    Defines, Edits, Removes, Switches and Defaults to Shortcutted Source Directories. scut started without a parameter or with the name @@ -113,7 +225,7 @@
    +
    ssvn
    +

    +
    Usage: ssvn [OPTIONS]
    This is the simple to use sSVN, written for newbies. It only Creates, Updates or cleans up your ReactOS Source Tree or shows the @@ -146,5 +261,27 @@
    +update +
    +

    +
    +
    Usage: update [OPTIONS]
    +Updates all files of RosBE to the most recent files.
    +
    +
    + +
    +
    Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/config.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/config.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/config.html [iso-8859= -1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/config.html [iso-8859= -1] Sat Jan 24 08:46:21 2009 @@ -1,22 +1,86 @@ - + Config + content=3D"Lists the Settings in the Config Script in RosBE.">
    -

    -
    -
    +
    SARCH: + +
    Sub-architecture to build for. Right now you can only select +xbox, which enables some code needed to run ROS on a XBox 1
    + +OARCH:
    +Generate instructions for this CPU type. See CPU Type list below. +
    +
    TUNE:
    +
    +
    Which CPU ReactOS should be optimized for.  Specify one of +the above CPUs or generic. When this option is not used, GCC will +optimize for the processor specified by OARCH.See CPU Type list below.
    +
    +OPTIMIZE:
    +What level of optimisation to use. +
    +
    KDBG:
    +
    +
    Whether to compile in the integrated kernel debugger.
    +
    +DBG:
    +Whether to compile for debugging. No compiler optimizations will be +performed. +
    +
    GDB:
    +
    +
    Whether to compile for debugging with GDB. If you don't use GDB, +don't enable this.
    +
    +NSWPAT:
    +Whether to compile apps/libs with features covered software patents or +not. If you live in a country where software patents are valid/apply, +don't enable this (except they/you purchased a license from the patent +owner). +
    +
    _WINKD_<= span + style=3D"font-weight: bold; font-style: italic;">:
    +
    +
    Whether to compile with the KD protocol. This will disable +support for KDBG as well as rossym and symbol lookups, and allow WinDBG +to connect to ReactOS. This is currently not fully working, and +requires kdcom from Windows 2003 or TinyKRNL. Booting into debug mode +with this flag enabled will result in a failure to enter GUI mode. Do +not enable unless you know what you're doing.
    +
    +_ELF_:
    +Whether to compile support for ELF files. Do not enable unless you know +what you're doing. +
    +
    BUILD_MP= :
    +
    +
    Whether to compile the multi processor versions for ntoskrnl and +hal.
    +
    +
    +
    +CPU Type +List:

    + + + + @@ -68,6 +132,13 @@ + + + + @@ -101,6 +172,28 @@ extensions.) + + + + + + + + + + + +
    i386Intel's i386 CPU. (No scheduling +is implemented for this chip.)
    i486 Intel's i486 CPU. (No scheduling is implemented for this chip.) Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE, SSE2 and SSE3 instruction set support.
    core2
    +
    Intel Dual Core CPU, MMX, SSE, +SSE2 and SSE3 instruction set support.
    +
    k6
    opteron-sse3
    +
    AMD K8 core based CPUs with +x86-64 instruction set support. (This supersets +MMX, SSE, SSE2, SSE3, 3dNOW!, enhanced 3dNOW! and 64-bit instruction +set +extensions.)
    barcelona
    +
    AMD Multi Core CPU. MMX, SSE, +SSE2, SSE3, 3dNOW!, enhanced 3dNOW! Support
    geode
    +
    Low power version AMD CPU. MMX, +SSE, SSE2, 3dNOW!, enhanced 3dNOW! Support
    +
    winchip-c6 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction @@ -128,7 +221,5 @@

    -
    -
    Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/credits.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/credits.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/credits.html [iso-885= 9-1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/credits.html [iso-885= 9-1] Sat Jan 24 08:46:21 2009 @@ -1,35 +1,28 @@ - - - + + - - Credits - - + + Credits + + -

    This Build Environment is inspired by blight's ReactOS Build Environment +

    This Build Environment is inspired by blight's ReactOS Build +Environment v0.2-3.4.5 and Dazzle from TinyKRNL ( - - http://www.tinykrnl.org/ + http://www.tinykrnl.org/ )

    Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/features.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html [iso-88= 59-1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/features.html [iso-88= 59-1] Sat Jan 24 08:46:21 2009 @@ -1,21 +1,25 @@ - + Features - + -

    * =3D This Feature is not supported under Windows Vista!

    +

    * =3D This Feature is not fully supported under Windows Vista!

    Modified: trunk/tools/RosBE/RosBE-Windows/Documentation/files/howto.html URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Docum= entation/files/howto.html?rev=3D39062&r1=3D39061&r2=3D39062&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- trunk/tools/RosBE/RosBE-Windows/Documentation/files/howto.html [iso-8859-= 1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Documentation/files/howto.html [iso-8859-= 1] Sat Jan 24 08:46:21 2009 @@ -1,66 +1,78 @@ + RosBE Frequently Asked Questions - + -