Author: dreimer Date: Tue Oct 28 12:52:14 2008 New Revision: 37043
URL: http://svn.reactos.org/svn/reactos?rev=37043&view=rev Log: Overhaul of the help file. Now it starts to be worth its name.
Modified: trunk/tools/RosBE/RosBE-Windows/Powershell/Help.ps1 trunk/tools/RosBE/RosBE-Windows/Root/Help.cmd
Modified: trunk/tools/RosBE/RosBE-Windows/Powershell/Help.ps1 URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Powershel... ============================================================================== --- trunk/tools/RosBE/RosBE-Windows/Powershell/Help.ps1 [iso-8859-1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Powershell/Help.ps1 [iso-8859-1] Tue Oct 28 12:52:14 2008 @@ -13,17 +13,16 @@ if ("$args" -eq "") { "" "Available Commands:" - " make [OPTIONS] - Without options it does a standard build of" - " ReactOS. OPTIONS are the standard ReactOS build" - " options ie. ""bootcd""" + " make [OPTIONS] - Make does a standard build of ReactOS. OPTIONS are" + " the standard ReactOS build options." " makex [OPTIONS] - Same as 'make' but automatically determines the" - " number of CPU Cores in the system and uses -j" - " with the appropriate number." + " number of CPU Cores in the system and uses -j with" + " the appropriate number." " basedir - Switch back to the ReactOS source directory."
if (Test-Path "$_ROSBE_BASEDIR\charch.ps1") { - " charch [OPTIONS] - Change the Architecture to build for the" - " current RosBE session." + " charch [OPTIONS] - Change the Architecture to build ReactOS for" + " for the current RosBE session." }
if (Test-Path "$_ROSBE_BASEDIR\chdefdir.ps1") { @@ -32,18 +31,18 @@ }
if (Test-Path "$_ROSBE_BASEDIR\chdefgcc.ps1") { - " chdefgcc [PATH] - Change the MinGW/GCC directory for the" - " current RosBE session." - } - - " clean [OPTIONS] - Fully clean the ReactOS source directory and/or" - " the RosBE build logs." + " chdefgcc [PATH] - Change the Host or Target MinGW/GCC directory" + " for the current RosBE session." + } + + " clean [OPTIONS] - Fully clean the ReactOS source directory and/or the" + " RosBE build logs."
if (Test-Path "$_ROSBE_BASEDIR\Config.ps1") { " config [OPTIONS] - Configures the way, ReactOS will be built." }
- " help [COMMAND] - Display the available commands or help on a" + " help [COMMAND] - Display the available commands or give help on a" " specific command."
if (Test-Path "$_ROSBE_BASEDIR\reladdr2line.ps1") { @@ -64,7 +63,8 @@ }
if (Test-Path "$_ROSBE_BASEDIR\options.ps1") { - " options - Starts the RosBE configurator." + " options - Starts the RosBE configurator and sets the." + " changes active immediately." }
if (Test-Path "$_ROSBE_BASEDIR\update.ps1") { @@ -81,15 +81,50 @@ # if ("$args" -eq "make") { " Usage: make [OPTIONS]" - " Without options it does a standard build of ReactOS. OPTIONS are the" - " standard ReactOS build options ie. ""bootcd"", ""livecd"", etc." + " Make does a standard build of ReactOS. OPTIONS are the standard ReactOS build" + " options:" + "" + " all - This target builds all of ReactOS." + " ""module"" - Builds only the module with the appropiate name." + " bootcd - Generates a BootCD ISO." + " livecd - Generates a LiveCD ISO." + " install - Installs ReactOS in the folder specified by the" + " environment variable ""ROS_INSTALL""." + " ""module""_install - Installs only the module with the appropiate name in" + " the folder specified by the environment variable" + " ""ROS_INSTALL""." + " clean - Deletes all files generated by the build process." + " ""module""_clean - Deletes only the files of one module with the" + " appropiate name." + " depends - Does a full dependency check on the ReactOS Source" + " and generates a new makefile. This will take a while." + " ""module""-depends - Does a dependency check for one module with the" + " appropiate name." exit } if ("$args" -eq "makex") { " Usage: makex [OPTIONS]" - " Same as 'make' but automatically determines the number of CPU Cores in" - " the system and uses ""make -j x"" with the appropriate number." - " NOTE: The number makex uses can be modified by editing Build.ps1" + " 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:" + "" + " all - This target builds all of ReactOS." + " ""module"" - Builds only the module with the appropiate name." + " bootcd - Generates a BootCD ISO." + " livecd - Generates a LiveCD ISO." + " install - Installs ReactOS in the folder specified by the" + " environment variable ""ROS_INSTALL""." + " ""module""_install - Installs only the module with the appropiate name in" + " the folder specified by the environment variable" + " ""ROS_INSTALL""." + " clean - Deletes all files generated by the build process." + " ""module""_clean - Deletes only the files of one module with the" + " appropiate name." + " depends - Does a full dependency check on the ReactOS Source" + " and generates a new makefile. This will take a while." + " ""module""-depends - Does a dependency check for one module with the" + " appropiate name." + " NOTE: The number makex uses can be modified by editing Build.cmd" " located in the RosBE directory, instructions for doing so are" " contained within the file." exit @@ -102,7 +137,7 @@ if (Test-Path "$_ROSBE_BASEDIR\charch.ps1") { if ("$args" -eq "charch") { " Usage: charch [OPTIONS]" - " Change the ReactOS source directory for the current RosBE session." + " Change the Architecture to build ReactOS for, for the current RosBE session." " Possible Architectures are: i386, ppc, arm, amd64." "" exit @@ -122,6 +157,8 @@ " Usage: chdefgcc [PATH]" " Change the MinGW/GCC directory for the current RosBE session." "" + " Path - Path to set the Host or Target GCC to." + " Type - Set it to ""target"" or ""host""" exit } } @@ -138,10 +175,10 @@ " Usage: config [OPTIONS]" " Creates a configuration file, which tells RosBE how to build the tree." "" - " 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." + " delete - Deletes the created configuration file and so sets back to the" + " default settings." + " update - Deletes the old created configuration file and updates it with a" + " new, default one." exit } } @@ -153,15 +190,14 @@ if (Test-Path "$_ROSBE_BASEDIR\reladdr2line.ps1") { if ("$args" -eq "raddr2line") { " Usage: raddr2line [FILE] [ADDRESS]" - " Translates program addresses into file names and line numbers to" - " assist developers with finding specific bugs in ReactOS. If" - " either of the options is not given you will be prompted for it." - "" - " FILE - 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." + " Translates program addresses into file names and line numbers to assist" + " developers with finding specific bugs in ReactOS. If either of the options" + " is not given you will be prompted for it." + "" + " FILE - 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." " ADDRESS - The address to be translated." "" exit @@ -176,11 +212,11 @@ if (Test-Path "$_ROSBE_BASEDIR\sSVN.ps1") { if ("$args" -eq "ssvn") { " Usage: ssvn [OPTIONS]" - " Creates, updates or cleans up your ReactOS source tree or shows the" - " revision number of the local and online trees." - "" - " update - Updates to HEAD revision or to a specific one when" - " second parameter specifies one." + " Creates, updates or cleans up your ReactOS source tree or shows the revision" + " number of the local and online trees." + "" + " update - Updates to HEAD revision or to a specific one when the second" + " parameter specifies one." " create - Creates a new ReactOS source tree." " cleanup - Cleans up and fixes errors in the source tree." " status - Show the current local and online revision numbers." @@ -190,7 +226,8 @@ if (Test-Path "$_ROSBE_BASEDIR\options.ps1") { if ("$args" -eq "options") { " Usage: options" - " Starts the RosBE configurator." + " Starts the RosBE configurator and sets the changes active in the current." + " RosBE session." exit } }
Modified: trunk/tools/RosBE/RosBE-Windows/Root/Help.cmd URL: http://svn.reactos.org/svn/reactos/trunk/tools/RosBE/RosBE-Windows/Root/Help... ============================================================================== --- trunk/tools/RosBE/RosBE-Windows/Root/Help.cmd [iso-8859-1] (original) +++ trunk/tools/RosBE/RosBE-Windows/Root/Help.cmd [iso-8859-1] Tue Oct 28 12:52:14 2008 @@ -19,17 +19,16 @@ if "%1" == "" ( echo. echo Available Commands: - echo make [OPTIONS] - Without options it does a standard build of - echo ReactOS. OPTIONS are the standard ReactOS build - echo options ie. "bootcd" + echo make [OPTIONS] - Make does a standard build of ReactOS. OPTIONS are + echo the standard ReactOS build options. echo makex [OPTIONS] - Same as 'make' but automatically determines the - echo number of CPU Cores in the system and uses -j - echo with the appropriate number. + echo number of CPU Cores in the system and uses -j with + echo the appropriate number. echo basedir - Switch back to the ReactOS source directory.
if exist "%_ROSBE_BASEDIR%\charch.cmd" ( - echo charch [OPTIONS] - Change the Architecture to build for the - echo current RosBE session. + echo charch [OPTIONS] - Change the Architecture to build ReactOS for + echo for the current RosBE session. )
if exist "%_ROSBE_BASEDIR%\chdefdir.cmd" ( @@ -38,18 +37,18 @@ )
if exist "%_ROSBE_BASEDIR%\chdefgcc.cmd" ( - echo chdefgcc [OPTIONS] - Change the MinGW/GCC directory for the - echo current RosBE session. - ) - - echo clean [OPTIONS] - Fully clean the ReactOS source directory and/or - echo the RosBE build logs. + echo chdefgcc [OPTIONS] - Change the Host or Target MinGW/GCC directory + echo for the current RosBE session. + ) + + echo clean [OPTIONS] - Fully clean the ReactOS source directory and/or the + echo RosBE build logs.
if exist "%_ROSBE_BASEDIR%\Config.cmd" ( echo config [OPTIONS] - Configures the way, ReactOS will be built. )
- echo help [COMMAND] - Display the available commands or help on a + echo help [COMMAND] - Display the available commands or give help on a echo specific command.
if exist "%_ROSBE_BASEDIR%\reladdr2line.cmd" ( @@ -70,7 +69,8 @@ )
if exist "%_ROSBE_BASEDIR%\options.cmd" ( - echo options - Starts the RosBE configurator. + echo options - Starts the RosBE configurator and sets the + echo changes active immediately. )
if exist "%_ROSBE_BASEDIR%\update.cmd" ( @@ -87,14 +87,49 @@ :: if /i "%1" == "make" ( echo Usage: make [OPTIONS] - echo Without options it does a standard build of ReactOS. OPTIONS are the - echo standard ReactOS build options ie. "bootcd", "livecd", etc. + echo Make does a standard build of ReactOS. OPTIONS are the standard ReactOS build + echo options: + echo. + echo all - This target builds all of ReactOS. + echo "module" - Builds only the module with the appropiate name. + echo bootcd - Generates a BootCD ISO. + echo livecd - Generates a LiveCD ISO. + echo install - Installs ReactOS in the folder specified by the + echo environment variable "ROS_INSTALL". + echo "module"_install - Installs only the module with the appropiate name in + echo the folder specified by the environment variable + echo "ROS_INSTALL". + echo clean - Deletes all files generated by the build process. + echo "module"_clean - Deletes only the files of one module with the + echo appropiate name. + echo depends - Does a full dependency check on the ReactOS Source + echo and generates a new makefile. This will take a while. + echo "module"-depends - Does a dependency check for one module with the + echo appropiate name. goto :EOC ) if /i "%1" == "makex" ( echo Usage: makex [OPTIONS] - echo Same as 'make' but automatically determines the number of CPU Cores in - echo the system and uses "make -j x" with the appropriate number. + echo Same as 'make' but automatically determines the number of CPU Cores in the + echo system and uses "make -j x" with the appropriate number. OPTIONS are the + echo standard ReactOS build options: + echo. + echo all - This target builds all of ReactOS. + echo "module" - Builds only the module with the appropiate name. + echo bootcd - Generates a BootCD ISO. + echo livecd - Generates a LiveCD ISO. + echo install - Installs ReactOS in the folder specified by the + echo environment variable "ROS_INSTALL". + echo "module"_install - Installs only the module with the appropiate name in + echo the folder specified by the environment variable + echo "ROS_INSTALL". + echo clean - Deletes all files generated by the build process. + echo "module"_clean - Deletes only the files of one module with the + echo appropiate name. + echo depends - Does a full dependency check on the ReactOS Source + echo and generates a new makefile. This will take a while. + echo "module"-depends - Does a dependency check for one module with the + echo appropiate name. echo NOTE: The number makex uses can be modified by editing Build.cmd echo located in the RosBE directory, instructions for doing so are echo contained within the file. @@ -108,7 +143,7 @@ if exist "%_ROSBE_BASEDIR%\charch.cmd" ( if /i "%1" == "charch" ( echo Usage: charch [OPTIONS] - echo Change the ReactOS source directory for the current RosBE session. + echo Change the Architecture to build ReactOS for, for the current RosBE session. echo Possible Architectures are: i386, ppc, arm, amd64. echo. goto :EOC @@ -128,7 +163,7 @@ echo Usage: chdefgcc [OPTIONS] echo Change the MinGW/GCC Target/Host directory for the current RosBE session. echo. - echo Path - Path to set the Host of Target GCC to. + echo Path - Path to set the Host or Target GCC to. echo Type - Set it to "target" or "host" goto :EOC ) @@ -146,10 +181,10 @@ echo Usage: config [OPTIONS] echo Creates a configuration file, which tells RosBE how to build the tree. echo. - echo delete - Deletes the created configuration file and so sets back - echo to default settings. - echo update - Deletes the old created configuration file and updates - echo it with a new, default one. + echo delete - Deletes the created configuration file and so sets back to default + echo settings. + echo update - Deletes the old created configuration file and updates it with a + echo new, default one. goto :EOC ) ) @@ -161,15 +196,14 @@ if exist "%_ROSBE_BASEDIR%\reladdr2line.cmd" ( if /i "%1" == "raddr2line" ( echo Usage: raddr2line [FILE] [ADDRESS] - echo Translates program addresses into file names and line numbers to - echo assist developers with finding specific bugs in ReactOS. If - echo either of the options is not given you will be prompted for it. - echo. - echo FILE - This can be either a fully specified path or just the - echo file name [you can use a partial name ie. ntdll*] of - echo the executable to be analyzed. When using just a file - echo the current directory and all sub-directories are - echo searched. + echo Translates program addresses into file names and line numbers to assist + echo developers with finding specific bugs in ReactOS. If either of the options + echo is not given you will be prompted for it. + echo. + echo FILE - This can be either a fully specified path or just the file name + echo [you can use a partial name ie. ntdll*] of the executable to be + echo analyzed. When using just a file the current directory and all + echo sub-directories are searched. echo ADDRESS - The address to be translated. echo. goto :EOC @@ -184,11 +218,11 @@ if exist "%_ROSBE_BASEDIR%\sSVN.cmd" ( if /i "%1" == "ssvn" ( echo Usage: ssvn [OPTIONS] - echo Creates, updates or cleans up your ReactOS source tree or shows the - echo revision number of the local and online trees. - echo. - echo update - Updates to HEAD revision or to a specific one when - echo second parameter specifies one. + echo Creates, updates or cleans up your ReactOS source tree or shows the revision + echo number of the local and online trees. + echo. + echo update - Updates to HEAD revision or to a specific one when the second + echo parameter specifies one. echo create - Creates a new ReactOS source tree. echo cleanup - Cleans up and fixes errors in the source tree. echo status - Show the current local and online revision numbers. @@ -198,7 +232,8 @@ if exist "%_ROSBE_BASEDIR%\options.cmd" ( if /i "%1" == "options" ( echo Usage: options - echo Starts the RosBE configurator. + echo Starts the RosBE configurator and sets the changes active in the current + echo RosBE session. goto :EOC ) )
-
dreimer＠svn.reactos.org