Boost logo

Boost-Commit :

From: jurko.gospodnetic_at_[hidden]
Date: 2008-08-31 18:28:38


Author: jurko
Date: 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
New Revision: 48507
URL: http://svn.boost.org/trac/boost/changeset/48507

Log:
Cleaned up Boost Build example readme.txt files a bit.
Added:
   trunk/tools/build/v2/example/hello/readme.txt (contents, props changed)
Text files modified:
   trunk/tools/build/v2/example/customization/readme.txt | 10 +++++-----
   trunk/tools/build/v2/example/generate/REAME.txt | 18 +++++++-----------
   trunk/tools/build/v2/example/generator/README.txt | 7 +++----
   trunk/tools/build/v2/example/gettext/readme.txt | 13 ++++++-------
   trunk/tools/build/v2/example/hello/jamroot.jam | 1 -
   trunk/tools/build/v2/example/make/readme.txt | 6 +++---
   trunk/tools/build/v2/example/python_modules/readme.txt | 15 ++++++++-------
   trunk/tools/build/v2/example/qt/README.txt | 15 +++++++--------
   8 files changed, 39 insertions(+), 46 deletions(-)

Modified: trunk/tools/build/v2/example/customization/readme.txt
==============================================================================
--- trunk/tools/build/v2/example/customization/readme.txt (original)
+++ trunk/tools/build/v2/example/customization/readme.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -3,9 +3,9 @@
 (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
 
 
-This example show how to add a new target type and a new tool
-support to Boost.Build. Please refer to extender manual for
-complete description of this example.
+This example show how to add a new target type and a new tool support to
+Boost.Build. Please refer to extender manual for a complete description of this
+example.
 
-Note that this example requires Python. If cygwin Python on Windows is
-to be used, please go to "verbatim.jam" and follow instructions there.
+Note that this example requires Python. If cygwin Python on Windows is to be
+used, please go to "verbatim.jam" and follow instructions there.

Modified: trunk/tools/build/v2/example/generate/REAME.txt
==============================================================================
--- trunk/tools/build/v2/example/generate/REAME.txt (original)
+++ trunk/tools/build/v2/example/generate/REAME.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,15 +1,11 @@
+# Copyright 2007 Vladimir Prus
+# 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)
 
-This example shows the 'generate' rule, that
-allows you to construct target using any arbitrary
-set of transformation and commands.
+This example shows the 'generate' rule, that allows you to construct target
+using any arbitrary set of transformation and commands.
 
-The rule is similar to 'make' and 'notfile', but
-unlike those, you can operate in terms of
-Boost.Build 'virtual targets', which is more
-flexible.
+The rule is similar to 'make' and 'notfile', but unlike those, you can operate
+in terms of Boost.Build 'virtual targets', which is more flexible.
 
 Please consult the docs for more explanations.
-
-# Copyright 2007 Vladimir Prus
-# 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)

Modified: trunk/tools/build/v2/example/generator/README.txt
==============================================================================
--- trunk/tools/build/v2/example/generator/README.txt (original)
+++ trunk/tools/build/v2/example/generator/README.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,7 +1,6 @@
-
-This example shows how to declare a new generator class. It's necessary
-when generator's logic is more complex that just running a single tool.
-
 # Copyright 2006 Vladimir Prus
 # 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)
+
+This example shows how to declare a new generator class. It is necessary when
+generator's logic is more complex that just running a single tool.

Modified: trunk/tools/build/v2/example/gettext/readme.txt
==============================================================================
--- trunk/tools/build/v2/example/gettext/readme.txt (original)
+++ trunk/tools/build/v2/example/gettext/readme.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,14 +1,14 @@
-Copyright 2003 Vladimir Prus
-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)
+Copyright 2003 Vladimir Prus
+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)
 
 
-This example shows how it's possible to used GNU gettext utilities with
+This example shows how it is possible to use GNU gettext utilities with
 Boost.Build.
 
 A simple translation file is compiled and installed as message catalog for
-russian. The main application explicitly switches to russian locale and
-output the translation of "hello".
+russian. The main application explicitly switches to russian locale and outputs
+the translation of "hello".
 
 To test:
 
@@ -22,4 +22,3 @@
    - edit "russian.po"
    - run bjam
    - run "main"
-

Modified: trunk/tools/build/v2/example/hello/jamroot.jam
==============================================================================
--- trunk/tools/build/v2/example/hello/jamroot.jam (original)
+++ trunk/tools/build/v2/example/hello/jamroot.jam 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,2 +1 @@
-
 exe hello : hello.cpp ;

Added: trunk/tools/build/v2/example/hello/readme.txt
==============================================================================
--- (empty file)
+++ trunk/tools/build/v2/example/hello/readme.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -0,0 +1,7 @@
+Copyright 2008 Jurko Gospodnetic
+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)
+
+
+This example shows a very basic Boost Build project set up so it compiles a
+single executable from a single source file.

Modified: trunk/tools/build/v2/example/make/readme.txt
==============================================================================
--- trunk/tools/build/v2/example/make/readme.txt (original)
+++ trunk/tools/build/v2/example/make/readme.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,6 +1,6 @@
-Copyright 2002, 2005 Vladimir Prus
-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)
+Copyright 2002, 2005 Vladimir Prus
+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)
 
 
 Example of using custom command to create one file from another, using the

Modified: trunk/tools/build/v2/example/python_modules/readme.txt
==============================================================================
--- trunk/tools/build/v2/example/python_modules/readme.txt (original)
+++ trunk/tools/build/v2/example/python_modules/readme.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -1,6 +1,6 @@
-Copyright 2006 Vladimir Prus
-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)
+Copyright 2006 Vladimir Prus
+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)
 
 
 This example shows how you can use Python modules from Boost.Build.
@@ -8,8 +8,9 @@
 In order to do this, you need to build bjam with Python support, by running:
 
    ./build.sh --with-python=/usr
-
-in jam directory. (Replace /usr with the root of your Python installation.)
 
-The integration between Python and bjam is very basic now, but enough to
-be useful.
+in the jam/src directory (replace /usr with the root of your Python
+installation).
+
+The integration between Python and bjam is very basic now, but enough to be
+useful.

Modified: trunk/tools/build/v2/example/qt/README.txt
==============================================================================
--- trunk/tools/build/v2/example/qt/README.txt (original)
+++ trunk/tools/build/v2/example/qt/README.txt 2008-08-31 18:28:38 EDT (Sun, 31 Aug 2008)
@@ -7,15 +7,14 @@
 (http://www.trolltech.com/products/qt/index.html).
 
 The current examples are:
-1. Basic setup -- application with several sources and moccable header.
-2. Using of .ui source file.
-3. Running .cpp files via the moc tool.
+ 1. Basic setup -- application with several sources and moccable header.
+ 2. Using of .ui source file.
+ 3. Running .cpp files via the moc tool.
 
-For convenience, there are examples both for 3.* and 4.* version of Qt,
-they are mostly identical and differ only in source code.
+For convenience, there are examples both for 3.* and 4.* version of Qt, they are
+mostly identical and differ only in source code.
 
 All examples assumes that you just installed Boost.Build and that QTDIR
 environment variables is set (typical values can be /usr/share/qt3 and
-/usr/share/qt4). After adding "using qt ..." to your user-config.jam, you'd
-have to removing "using qt ; " statements from Jamroot file of examples.
-
+/usr/share/qt4). After adding "using qt ..." to your user-config.jam, you would
+have to remove "using qt ; " statements from example Jamroot files.


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