2
0
mirror of https://gitlab.com/ita1024/waf.git synced 2024-11-10 12:19:13 +01:00
Go to file
Josh Bartel 81c3ec0bf3
doxygen: Add install support
This adds support to the doxygen tool for installing the documentation
that was generated.  A new install_path attribute can be added to the
doxygen TaskGen to control where it should be installed to.

Signed-off-by: Thomas Nagy <tnagy2pow10@gmail.com>
2014-06-09 00:33:20 +02:00
build_system_kit Initial commit 2011-09-10 11:13:51 +02:00
demos moved pch out of demos (requires extras/pch.py) and disabled the dependency on boost 2014-05-21 01:37:14 +02:00
docs treecleaner: 'in [...]' replaced by 'in (...)' where appropriate 2014-01-05 16:27:06 -05:00
playground moved pch out of demos (requires extras/pch.py) and disabled the dependency on boost 2014-05-21 01:37:14 +02:00
tests Issue 1454 2014-05-21 17:21:29 +02:00
utils support for included gpg signatures (use utils/verify-sig.py to verify them) 2014-03-05 22:52:54 +01:00
waflib doxygen: Add install support 2014-06-09 00:33:20 +02:00
zip waf-zip: zip-packed waf 2013-08-12 19:34:43 -04:00
.gitignore Revert the build* change to .gitignore since it's likely to have unintended side-effects on Windows. 2012-06-21 17:44:18 +02:00
ChangeLog command-line options override environment variables, and not the other way around 2014-01-06 15:00:45 +01:00
configure Initial commit 2011-09-10 11:13:51 +02:00
DEVEL docs 2013-11-09 15:29:22 +01:00
README added a note regarding the branch waf-1.7 2014-01-26 01:27:02 +01:00
TODO Try to re-use the same python interpreter on the build farm (AIX) 2012-07-09 11:51:43 +02:00
waf-light Escape null bytes potentially present in the waf file - workaround for Pypy 2.3 2014-05-10 06:17:00 +02:00
wscript Escape null bytes potentially present in the waf file - workaround for Pypy 2.3 2014-05-10 06:17:00 +02:00

WHAT YOU WILL FIND HERE
-----------------------

Waf 1.8 - for Waf 1.7 use the branch waf-1.7

For the manual: http://docs.waf.googlecode.com/git/book_16/single.html
For the api docs: http://docs.waf.googlecode.com/git/apidocs_16/index.html
For the examples: see the folder demos/

HOW TO CREATE THE WAF SCRIPT
----------------------------

Python 2.6, 2.7, 3.0, 3.1 or 3.2 is required to generate the waf script. Execute:
$ ./waf-light configure build
Or, if you have several python versions installed:
$ python3 ./waf-light configure build

The Waf tools in waflib/extras are not added to the waf script. To add
some of them, use the --tools switch:
$ ./waf-light --tools=compat15,swig

To add a tool that does not exist in the folder extras, pass an absolute path, and
to customize the initialization, pass the parameter 'prelude'. Here is for example
how to create a waf file using the compat15 module:
$ ./waf-light --tools=compat15 --prelude=$'\tfrom waflib.extras import compat15\n'

Any kind of initialization is possible, though one may prefer the build system kit (folder build_system_kit):
$ ./waf-light --make-waf --tools=compat15,/comp/waf/aba.py --prelude=$'\tfrom waflib.extras import compat15\n\tprint("ok")'

Or if you do not want to regenerate the waf file all the time, set the WAFDIR environment variable to the directory containing "waflib".

HOW TO TRY THE EXAMPLES
-----------------------

Try this:
$ cp waf demos/c/
$ cd demos/c/
$ ./waf configure build

USING GIT
---------

$ git clone https://code.google.com/p/waf/
set $HOME/.netrc to read:
machine code.google.com login user@gmail.com password pass
$ git remote add code https://code.google.com/p/waf.docs/
... make a few changes
$ git push code

---------------------------
Thomas Nagy, 2014 (ita)