From 7f3fee011fafd87195289ec35d81386e3fd8ac88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jurko=20Gospodneti=C4=87?= Date: Sun, 31 Aug 2008 22:28:38 +0000 Subject: [PATCH] Cleaned up Boost Build example readme.txt files a bit. [SVN r48507] --- v2/example/customization/readme.txt | 10 +++++----- v2/example/generate/REAME.txt | 20 ++++++++------------ v2/example/generator/README.txt | 7 +++---- v2/example/gettext/readme.txt | 13 ++++++------- v2/example/hello/jamroot.jam | 1 - v2/example/hello/readme.txt | 7 +++++++ v2/example/make/readme.txt | 6 +++--- v2/example/python_modules/readme.txt | 15 ++++++++------- v2/example/qt/README.txt | 15 +++++++-------- 9 files changed, 47 insertions(+), 47 deletions(-) create mode 100644 v2/example/hello/readme.txt diff --git a/v2/example/customization/readme.txt b/v2/example/customization/readme.txt index da0e37972..7ee04f1a2 100644 --- a/v2/example/customization/readme.txt +++ b/v2/example/customization/readme.txt @@ -3,9 +3,9 @@ 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 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. diff --git a/v2/example/generate/REAME.txt b/v2/example/generate/REAME.txt index e8cecc1ed..fc2b20772 100644 --- a/v2/example/generate/REAME.txt +++ b/v2/example/generate/REAME.txt @@ -1,15 +1,11 @@ - -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. - -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) + +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. + +Please consult the docs for more explanations. diff --git a/v2/example/generator/README.txt b/v2/example/generator/README.txt index c711dd206..f26a856a5 100644 --- a/v2/example/generator/README.txt +++ b/v2/example/generator/README.txt @@ -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. diff --git a/v2/example/gettext/readme.txt b/v2/example/gettext/readme.txt index 05816978a..9c8fee6fd 100644 --- a/v2/example/gettext/readme.txt +++ b/v2/example/gettext/readme.txt @@ -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 @@ To test even more: - edit "russian.po" - run bjam - run "main" - diff --git a/v2/example/hello/jamroot.jam b/v2/example/hello/jamroot.jam index 2d46eebe8..672ec02e9 100644 --- a/v2/example/hello/jamroot.jam +++ b/v2/example/hello/jamroot.jam @@ -1,2 +1 @@ - exe hello : hello.cpp ; diff --git a/v2/example/hello/readme.txt b/v2/example/hello/readme.txt new file mode 100644 index 000000000..f416be675 --- /dev/null +++ b/v2/example/hello/readme.txt @@ -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. diff --git a/v2/example/make/readme.txt b/v2/example/make/readme.txt index 40123b6ec..333c55a71 100644 --- a/v2/example/make/readme.txt +++ b/v2/example/make/readme.txt @@ -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 diff --git a/v2/example/python_modules/readme.txt b/v2/example/python_modules/readme.txt index 7eb87ffaf..0fe6ee55e 100644 --- a/v2/example/python_modules/readme.txt +++ b/v2/example/python_modules/readme.txt @@ -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 @@ This example shows how you can use Python modules from Boost.Build. 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. diff --git a/v2/example/qt/README.txt b/v2/example/qt/README.txt index c7af17cf0..d187c31c3 100644 --- a/v2/example/qt/README.txt +++ b/v2/example/qt/README.txt @@ -7,15 +7,14 @@ This directory contains Boost.Build examples for the Qt library (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.