docs update

This commit is contained in:
Thomas Nagy 2014-10-04 10:44:12 +02:00
parent 1979e7425c
commit 71e318e371
No known key found for this signature in database
GPG Key ID: 67A565EDFDF90E64
3 changed files with 18 additions and 20 deletions

View File

@ -178,7 +178,7 @@ out = 'build'
def configure(ctx):
ctx.find_program('touch', var='TOUCH')
ctx.check_waf_version(mini='1.7.11')
ctx.check_waf_version(mini='1.8.0')
ctx.find_file('fstab', ['/opt', '/etc'])
---------------
@ -394,7 +394,7 @@ Checking for program some_app : not found
$ cat build/config.log <2>
# project configured on Tue Jul 13 19:15:04 2010 by
# waf 1.7.11 (abi 98, python 20605f0 on linux2)
# waf 1.8.0 (abi 98, python 20605f0 on linux2)
# using /home/waf/bin/waf configure
#
Checking for program some_app

View File

@ -683,7 +683,7 @@ The outputs are written in the build directory into the file 'config.log':
[source,shishell]
------------------
# project configured on Tue Aug 31 17:30:21 2010 by
# waf 1.7.11 (abi 98, python 20605f0 on linux2)
# waf 1.8.0 (abi 98, python 20605f0 on linux2)
# using /home/waf/bin/waf configure
#
---

View File

@ -3,7 +3,7 @@
=== Obtaining the Waf file
The Waf project is located on http://code.google.com/p/waf[Google Code].
The current Waf version requires an interpreter for the Python programming language such as http://www.python.org[cPython] 2.3 to 3.1 or http://www.jython.org[Jython] >= 2.5.
The current Waf version requires an interpreter for the Python programming language such as http://www.python.org[cPython] 2.5 to 3.1, http://pypy.org[Pypy] or http://www.jython.org[Jython] >= 2.5.
==== Downloading and using the Waf binary
@ -11,10 +11,10 @@ The Waf binary is a python script which does not require any installation whatso
[source,shishell]
---------------
$ wget http://waf.googlecode.com/files/waf-1.7.11
$ mv waf-1.7.11 waf
$ wget http://ftp.waf.io/pub/release/waf-1.8.0
$ mv waf-1.8.0 waf
$ python waf --version
waf 1.7.11 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
waf 1.8.0 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
---------------
The +waf+ file has its own library compressed in a binary stream in the same file. Upon execution, the library is uncompressed in a hidden folder in the current directory. The folder will be re-created if removed. This scheme enables different Waf versions to be executed from the same folders:
@ -22,7 +22,7 @@ The +waf+ file has its own library compressed in a binary stream in the same fil
[source,shishell]
---------------
$ ls -ld .waf*
.waf-1.7.11-2c924e3f453eb715218b9cc852291170
.waf-1.8.0-2c924e3f453eb715218b9cc852291170
---------------
NOTE: The binary file requires http://docs.python.org/library/bz2.html[bzip2] compression support, which may be unavailable in some self-compiled cPython installations.
@ -33,18 +33,18 @@ Building Waf requires a Python interpreter having a version number in the range
[source,shishell]
---------------
$ wget http://waf.googlecode.com/files/waf-1.7.11.tar.bz2
$ tar xjvf waf-1.7.11.tar.bz2
$ cd waf-1.7.11
$ wget http://ftp.waf.io/pub/release/waf-1.8.0.tar.bz2
$ tar xjvf waf-1.8.0.tar.bz2
$ cd waf-1.8.0
$ python waf-light
Configuring the project
'build' finished successfully (0.001s)
Checking for program python : /usr/bin/python
Checking for python version : (2, 6, 5, 'final', 0)
'configure' finished successfully (0.176s)
Waf: Entering directory `/waf-1.7.11/build'
Waf: Entering directory `/waf-1.8.0/build'
[1/1] create_waf: -> waf
Waf: Leaving directory `/waf-1.7.11/build'
Waf: Leaving directory `/waf-1.8.0/build'
'build' finished successfully (2.050s)
---------------
@ -86,7 +86,7 @@ The following will create a custom waf file which will import and execute 'foo'
$ python waf-light --make-waf --tools=compat15,$PWD/aba.py
--prelude=$'\tfrom waflib.extras import aba\n\taba.foo()'
$ ./waf --help
This is Waf 1.7.11
This is Waf 1.8.0
[...]
---------------
@ -112,7 +112,7 @@ On unix-like systems, it is usually much more convenient to set the executable p
---------------
$ chmod 755 waf
$ ./waf --version
waf 1.7.11 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
waf 1.8.0 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
---------------
If the command-line interpreter supports aliases, it is recommended to set the alias once:
@ -121,7 +121,7 @@ If the command-line interpreter supports aliases, it is recommended to set the a
---------------
$ alias waf=$PWD/waf
$ waf --version
waf 1.7.11 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
waf 1.8.0 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
---------------
Or, the execution path may be modified to point at the location of the waf binary:
@ -130,7 +130,7 @@ Or, the execution path may be modified to point at the location of the waf binar
---------------
$ export PATH=$PWD:$PATH
$ waf --version
waf 1.7.11 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
waf 1.8.0 (54dc13ba5f51bfe2ae277451ec5ac1d0a91c7aaf)
---------------
In the next sections of the book, we assume that either an alias or the execution path have been set in a way that +waf+ may be called directly.
@ -146,9 +146,7 @@ image::waflib{PIC}["Waflib discovery"{backend@docbook:,width=220:},align="center
==== Portability concerns
By default, the recommended Python interpreter is cPython, for which the supported versions are 2.3 to 3.1. For maximum convenience for the user, a copy of the http://www.jython.org[Jython] interpreter in the version 2.5 may be redistributed along with a copy of the Waf executable.
NOTE: A project containing 'waf', 'jython2.5.jar' and the source code may be used almost anywhere.
By default, the recommended Python interpreter is cPython, for which the supported versions are 2.5 to 3.1. For maximum convenience for the user, a copy of the http://www.jython.org[Jython] interpreter in the version 2.5 could be redistributed along with a copy of the Waf executable.
WARNING: The 'waf' script must reside in a writable folder to unpack its cache files.