FWGS
/
waf
mirror of https://gitlab.com/ita1024/waf.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

More docs

This commit is contained in:
Thomas Nagy 2016-07-16 17:31:19 +02:00
parent f01c60d061
commit b73ccba03c
No known key found for this signature in database
GPG Key ID: 49B4C67C05277AAA
2 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/book/download.txt
View File

@ -22,7 +22,7 @@ $ ls -ld .waf*
.waf-{version}-2c924e3f453eb715218b9cc852291170
---------------
No installation is necessary, but the folder containing the Waf file must be writable. If this is not possible, use the instructions in the next section to point a *WAFDIR* environment variable.
No installation is necessary, but the folder containing the Waf file must be writable. If this is not possible, use the instructions in the next section to set the *WAFDIR* environment variable.
If http://docs.python.org/library/bz2.html[bzip2] compression support is missing in the python interpreter, please use the instructions in the next sections to build Waf from source.

10
docs/book/execution.txt
View File

@ -2,11 +2,7 @@
=== Waf commands
==== Waf and wscript files
As the Waf file is meant to be a generic utility for building projects, project-specific details are best kept and versioned in files residing along with the project source code.
The Waf project files are modules written in the Python programming language and are named *wscript*. Though they can contain any Python code, Waf can use specific functions and classes defined in them. The next sections will explore a particularly useful concept called *function commands*.
As the Waf file is meant to be a generic utility for building projects, project-specific details are best kept and versioned in files residing along with the project source code. These files are modules written in the Python programming language and are named *wscript*. Although they can contain any Python code, Waf can use specific functions and classes defined in them. The next sections will explore a particularly useful concept called *function commands*.
==== Command-line overview
@ -14,10 +10,10 @@ Waf is typically run in a command-line interpreter called terminall or shell; th
[source,shishell]
---------------
$ CFLAGS=-O3<1> waf distclean configure<2> -j1 --help<3>
$ CFLAGS=-O3 <1> waf distclean configure <2> -j1 --help <3>
---------------
<1> The CFLAGS value provides a way to provide arbitrary data in an unverified way, it is also called an environment variable.
<1> The *CFLAGS* argument is an environment variable; it is used to provide processes with arbitrary data in an unchecked way way
<2> Waf is instructed to run the two commands called *distclean* and *configure* in this specific order. Commands are passed after the 'waf' file and contain no *-* or *=* characters
<3> The *-j1* and *--help* elements are command-line options; they are optional and their position or order in the list of arguments is not meant to be significant.