Boost logo

Boost-Commit :

From: jurko.gospodnetic_at_[hidden]
Date: 2008-08-22 18:14:24


Author: jurko
Date: 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
New Revision: 48297
URL: http://svn.boost.org/trac/boost/changeset/48297

Log:
Minor stylistic changes made to several Boost Build implementation & toolset modules.
Text files modified:
   trunk/tools/build/v2/build-system.jam | 11 +++---
   trunk/tools/build/v2/build/targets.jam | 13 ++++---
   trunk/tools/build/v2/tools/common.jam | 20 ++++++------
   trunk/tools/build/v2/tools/generate.jam | 16 ++++-----
   trunk/tools/build/v2/tools/msvc.jam | 62 ++++++++++++++++++++--------------------
   5 files changed, 61 insertions(+), 61 deletions(-)

Modified: trunk/tools/build/v2/build-system.jam
==============================================================================
--- trunk/tools/build/v2/build-system.jam (original)
+++ trunk/tools/build/v2/build-system.jam 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
@@ -407,12 +407,12 @@
 
         if $(.debug-config)
         {
- ECHO "notice: [cmdline-cfg] Detected command-line request for"
+ ECHO notice: [cmdline-cfg] Detected command-line request for
                 $(toolset-version): "toolset=" $(toolset) "version="
                 $(version) ;
         }
 
- # If the toolset isn't known, configure it now.
+ # If the toolset is not known, configure it now.
         local known ;
         if $(toolset) in [ feature.values <toolset> ]
         {
@@ -443,13 +443,14 @@
         }
 
         # Make sure we get an appropriate property into the build request in
- # case toolset was specified using the "--toolset=..." command-line
+ # case toolset has been specified using the "--toolset=..." command-line
         # option form.
         if ! $(t) in $(.argv) && ! $(t) in $(feature-toolsets)
         {
             if $(.debug-config)
             {
- ECHO notice: [cmdline-cfg] adding toolset=$(t) "to build request." ;
+ ECHO notice: [cmdline-cfg] adding toolset=$(t) to the build
+ request. ;
             }
             extra-properties += toolset=$(t) ;
         }
@@ -546,7 +547,7 @@
         ECHO "warning: No toolsets are configured." ;
         ECHO "warning: Configuring default toolset" \"$(default-toolset)\". ;
         ECHO "warning: If the default is wrong, your build may not work correctly." ;
- ECHO "warning: Use the \"--toolset=xxxxx\" option to override our guess." ;
+ ECHO "warning: Use the \"toolset=xxxxx\" option to override our guess." ;
         ECHO "warning: For more configuration options, please consult" ;
         ECHO "warning: http://boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html" ;
 

Modified: trunk/tools/build/v2/build/targets.jam
==============================================================================
--- trunk/tools/build/v2/build/targets.jam (original)
+++ trunk/tools/build/v2/build/targets.jam 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
@@ -909,7 +909,7 @@
 
 # Given a 'context' -- a set of already present properties, and 'requirements',
 # decide which extra properties should be applied to 'context'. For conditional
-# requirements, this means evaluating condition. For indirect conditional
+# requirements, this means evaluating the condition. For indirect conditional
 # requirements, this means calling a rule. Ordinary requirements are always
 # applied.
 #
@@ -959,9 +959,10 @@
     local current = $(raw) ;
 
     # It is assumed that ordinary conditional requirements can not add
- # <indirect-conditional> properties, and that rules referred to by
- # <indirect-conditional> properties can not add new <indirect-conditional>
- # properties. So the list of indirect conditionals does not change.
+ # <conditional> properties (a.k.a. indirect conditional properties), and
+ # that rules referred to by <conditional> properties can not add new
+ # <conditional> properties. So the list of indirect conditionals does not
+ # change.
     local indirect = [ $(requirements).get <conditional> ] ;
     indirect = [ MATCH @(.*) : $(indirect) ] ;
 
@@ -980,7 +981,7 @@
 
         if $(e) = $(added-requirements)
         {
- # If we got the same result, we've found final properties.
+ # If we got the same result, we have found the final properties.
             count = ;
             ok = true ;
         }
@@ -1009,7 +1010,7 @@
     }
     else
     {
- errors.error "Invalid value of the 'what' parameter" ;
+ errors.error "Invalid value of the 'what' parameter." ;
     }
 }
 

Modified: trunk/tools/build/v2/tools/common.jam
==============================================================================
--- trunk/tools/build/v2/tools/common.jam (original)
+++ trunk/tools/build/v2/tools/common.jam 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
@@ -40,9 +40,9 @@
 # A toolset configuration may be in one of the following states:
 #
 # - registered
-# Configuration has been registered (e.g. by autodetection code) but has
-# not yet been marked as used, i.e. 'toolset.using' rule has not yet been
-# called for it.
+# Configuration has been registered (e.g. explicitly or by auto-detection
+# code) but has not yet been marked as used, i.e. 'toolset.using' rule has
+# not yet been called for it.
 # - used
 # Once called 'toolset.using' rule marks the configuration as 'used'.
 #
@@ -87,8 +87,8 @@
     # Mark a configuration as 'used'.
     #
     # Returns 'true' if the state of the configuration has been changed to
- # 'used' and an empty value if it the state wasn't changed. Reports an error
- # if the configuration isn't known.
+ # 'used' and an empty value if it the state has not been changed. Reports an
+ # error if the configuration is not known.
     #
     rule use ( id )
     {
@@ -103,7 +103,7 @@
         {
             self.used += $(id) ;
 
- # indicate that the configuration has been marked as 'used'
+ # Indicate that the configuration has been marked as 'used'.
             retval = true ;
         }
 
@@ -174,7 +174,7 @@
             }
             # The below logic is for intel compiler. It calls this rule with
             # 'intel-linux' and 'intel-win' as toolset, so we need to get the
- # base part of toolset name. We can't pass 'intel' as toolset
+ # base part of toolset name. We can not pass 'intel' as toolset
             # because in that case it will be impossible to register versionless
             # intel-linux and intel-win toolsets of a specific version.
             local t = $(toolset) ;
@@ -255,7 +255,7 @@
 # PATH and in the passed 'additional-path'. Otherwise, verifies that the first
 # element of 'user-provided-command' is an existing program.
 #
-# This rule returns the command to be used when invoking the tool. If we can't
+# This rule returns the command to be used when invoking the tool. If we can not
 # find the tool, a warning is issued. If 'path-last' is specified, PATH is
 # checked after 'additional-paths' when searching for 'tool'.
 #
@@ -268,7 +268,7 @@
         command = [ common.find-tool $(tool) : $(additional-paths) : $(path-last) ] ;
         if ! $(command) && $(.debug-configuration)
         {
- ECHO "warning: toolset $(toolset) initialization: can't find tool $(tool)" ;
+ ECHO "warning: toolset $(toolset) initialization: can not find tool $(tool)" ;
             ECHO "warning: initialized from" [ errors.nearest-user-location ] ;
         }
     }
@@ -278,7 +278,7 @@
         if ! $(command) && $(.debug-configuration)
         {
             ECHO "warning: toolset $(toolset) initialization: " ;
- ECHO "warning: can't find user-provided command " '$(user-provided-command)' ;
+ ECHO "warning: can not find user-provided command " '$(user-provided-command)' ;
             ECHO "warning: initialized from" [ errors.nearest-user-location ] ;
         }
     }

Modified: trunk/tools/build/v2/tools/generate.jam
==============================================================================
--- trunk/tools/build/v2/tools/generate.jam (original)
+++ trunk/tools/build/v2/tools/generate.jam 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
@@ -2,9 +2,8 @@
 # Distributed under the Boost Software License, Version 1.0.
 # (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
 
-# Declares main target 'generate' that can be used to produce targets
-# by calling a user-provides rule, that takes virtual target and produces
-# virtual target.
+# Declares main target 'generate' used to produce targets by calling a
+# user-provided rule that takes and produces virtual targets.
 
 import targets ;
 import "class" : new ;
@@ -31,11 +30,10 @@
         basic-target.__init__ $(name) : $(project) : $(sources)
             : $(requirements) : $(default-build) : $(usage-requirements) ;
 
- local r = [ $(self.requirements).get <generating-rule> ] ;
- if ! $(r)
+ if ! [ $(self.requirements).get <generating-rule> ]
         {
- errors.user-error
- "The generate rule requires <generating-rule> property to be set" ;
+ errors.user-error "The generate rule requires the <generating-rule>"
+ "property to be set" ;
         }
     }
 
@@ -44,8 +42,8 @@
         local result ;
         local gr = [ $(property-set).get <generating-rule> ] ;
 
- # FIXME: this is copy-paste from virtual-target.jam. Must
- # have n utilty rule to call a rule like this.
+ # FIXME: this is a copy-paste from virtual-target.jam. We should add a
+ # utility rule to call a rule like this.
         local rule-name = [ MATCH ^@(.*) : $(gr) ] ;
         if $(rule-name)
         {

Modified: trunk/tools/build/v2/tools/msvc.jam
==============================================================================
--- trunk/tools/build/v2/tools/msvc.jam (original)
+++ trunk/tools/build/v2/tools/msvc.jam 2008-08-22 18:14:23 EDT (Fri, 22 Aug 2008)
@@ -206,12 +206,10 @@
 
 local rule configure-really ( version ? : options * )
 {
- # Note that if no version supplied uses the default configuration condition
- # remains versionless.
     local v = $(version) ;
     if ! $(v)
     {
- # take the first detected version
+ # Take the first detected version.
         version = [ $(.versions).all ] ;
         version = $(version[1]) ;
         v = $(version) ;
@@ -221,13 +219,13 @@
         version ?= "default" ;
     }
 
- # Version alias -> real version number
+ # Version alias -> real version number.
     if $(.version-alias-$(version))
     {
         version = $(.version-alias-$(version)) ;
     }
 
- # Check whether selected configuration is used already
+ # Check whether the selected configuration is already in use.
     if $(version) in [ $(.versions).used ]
     {
         # Allow multiple 'toolset.using' calls for the same configuration if the
@@ -311,10 +309,11 @@
             # TODO: Note that if we specify a non-existant toolset version then
             # this rule may find and use a corresponding compiler executable
             # belonging to an incorrect toolset version. For example, if you
- # have only MSVC 7.1 installed and specify you want Boost Build to
- # use MSVC 9.0, then you want Boost Build to report an error but
- # this may cause it to silently use the MSVC 7.1 compiler even
- # though it thinks its using the msvc 9.0 toolset.
+ # have only MSVC 7.1 installed, have its executable on the path and
+ # specify you want Boost Build to use MSVC 9.0, then you want Boost
+ # Build to report an error but this may cause it to silently use the
+ # MSVC 7.1 compiler even though it thinks it is using the msvc-9.0
+ # toolset version.
             command = [ common.get-absolute-tool-path $(command[-1]) ] ;
 
             local parent = [ path.make $(command) ] ;
@@ -524,9 +523,10 @@
     toolset.push-checking-for-flags-module unchecked ;
     # Starting with versions 7.0, the msvc compiler have the /Zc:forScope and
     # /Zc:wchar_t options that improve C++ standard conformance, but those
- # options are off by default. If we're sure that msvc version is at 7.*, add
- # those options explicitly. We can be sure either if user specified version
- # 7.* explicitly, or if the installation path contain 7.* (checked above).
+ # options are off by default. If we are sure that msvc version is at 7.*,
+ # add those options explicitly. We can be sure either if user specified
+ # version 7.* explicitly, or if the installation path contain 7.* (checked
+ # above).
     if ! [ MATCH ^(6\\.) : $(version) ]
     {
         toolset.flags $(toolset).compile CFLAGS $(conditions) : /Zc:forScope /Zc:wchar_t ;
@@ -546,7 +546,7 @@
     }
 
     #
- # Processor-specific optimization
+ # Processor-specific optimization.
     #
 
     if [ MATCH ^([67]) : $(version) ]
@@ -590,7 +590,7 @@
 #
 local rule default-path ( version )
 {
- # Use auto-detected path if possible
+ # Use auto-detected path if possible.
     local path = [ feature.get-values <command> :
         [ $(.versions).get $(version) : options ] ] ;
 
@@ -600,7 +600,7 @@
     }
     else
     {
- # Check environment
+ # Check environment.
         if $(.version-$(version)-env)
         {
             local vc-path = [ os.environ $(.version-$(version)-env) ] ;
@@ -614,7 +614,7 @@
             }
         }
 
- # Check default path
+ # Check default path.
         if ! $(path) && $(.version-$(version)-path)
         {
             path = [ path.native [ path.join $(.ProgramFiles) $(.version-$(version)-path) ] ] ;
@@ -659,7 +659,7 @@
 generators.register-c-compiler msvc.compile.c++ : CPP : OBJ : <toolset>msvc ;
 generators.register-c-compiler msvc.compile.c : C : OBJ : <toolset>msvc ;
 
-# Using 'register-c-compiler' adds the build directory to INCLUDES
+# Using 'register-c-compiler' adds the build directory to INCLUDES.
 generators.register-c-compiler msvc.compile.rc : RC : OBJ(%_res) : <toolset>msvc ;
 generators.override msvc.compile.rc : rc.compile.resource ;
 generators.register-standard msvc.compile.asm : ASM : OBJ : <toolset>msvc ;
@@ -680,7 +680,7 @@
 
     rule run-pch ( project name ? : property-set : sources * )
     {
- # Searching header and source file in the sources.
+ # Searching for the header and source file in the sources.
         local pch-header ;
         local pch-source ;
         for local s in $(sources)
@@ -699,10 +699,10 @@
 
         if ! $(pch-header)
         {
- errors.user-error "can't build pch without pch-header" ;
+ errors.user-error "can not build pch without pch-header" ;
         }
 
- # If we don't have PCH source - that's fine. We'll just create a
+ # If we do not have the PCH source - that is fine. We will just create a
         # temporary .cpp file in the action.
 
         local generated = [ generator.run $(project) $(name)
@@ -883,7 +883,7 @@
 }
 
 
-# See midl.jam for details
+# See midl.jam for details.
 TOUCH_FILE = [ common.file-touch-command ] ;
 
 
@@ -899,8 +899,8 @@
 
 flags msvc.compile.asm USER_ASMFLAGS <asmflags> : ;
 
-#
-# for the assembler the following options are turned on by default:
+
+# For the assembler the following options are turned on by default:
 #
 # -coff generate COFF format object file (compatible with cl.exe output)
 # -Zp4 align structures to 4 bytes
@@ -913,11 +913,11 @@
 }
 
 
-# Declare flags and action for linking
+# Declare flags and action for linking.
 flags msvc.link PDB_LINKFLAG <debug-symbols>on/<debug-store>database : /PDB: ; # not used yet
 flags msvc.link LINKFLAGS <debug-symbols>on : /DEBUG ;
 flags msvc.link DEF_FILE <def-file> ;
-# The linker disables the default optimizations when using /DEBUG. Whe have to
+# The linker disables the default optimizations when using /DEBUG. We have to
 # enable them manually for release builds with debug symbols.
 flags msvc LINKFLAGS <debug-symbols>on/<runtime-debugging>off : /OPT:REF,ICF ;
 
@@ -967,9 +967,9 @@
 }
 
 
-# Incremental linking a DLL causes no end of problems: if the actual exports
-# do not change, the import .lib file is never updated. Therefore, the .lib is
-# always out-of-date and gets rebuilt every time. I'm not sure that incremental
+# Incremental linking a DLL causes no end of problems: if the actual exports do
+# not change, the import .lib file is never updated. Therefore, the .lib is
+# always out-of-date and gets rebuilt every time. I am not sure that incremental
 # linking is such a great idea in general, but in this case I am sure we do not
 # want it.
 
@@ -1041,7 +1041,7 @@
 .version-alias-9 = 9.0 ;
 
 # Name of the registry key that contains Visual C++ installation path
-# (relative to "HKEY_LOCAL_MACHINE\SOFTWARE\\Microsoft"
+# (relative to "HKEY_LOCAL_MACHINE\SOFTWARE\\Microsoft").
 .version-6.0-reg = "VisualStudio\\6.0\\Setup\\Microsoft Visual C++" ;
 .version-7.0-reg = "VisualStudio\\7.0\\Setup\\VC" ;
 .version-7.1-reg = "VisualStudio\\7.1\\Setup\\VC" ;
@@ -1094,8 +1094,8 @@
             for local x in "" "Wow6432Node\\"
             {
                 vc-path += [ W32_GETREG
- "HKEY_LOCAL_MACHINE\\SOFTWARE\\"$(x)"\\Microsoft\\"$(.version-$(i)-reg)
- : "ProductDir" ] ;
+ "HKEY_LOCAL_MACHINE\\SOFTWARE\\"$(x)"\\Microsoft\\"$(.version-$(i)-reg)
+ : "ProductDir" ] ;
             }
 
             if $(vc-path)


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk