2016-03-15 19:26:31 +01:00
|
|
|
Waf 1.9 is on https://github.com/waf-project/waf
|
2015-04-06 14:46:55 +02:00
|
|
|
------------------------------------------------
|
2011-09-10 11:13:51 +02:00
|
|
|
|
|
|
|
|
waflib the core library
|
|
|
|
|
waflib/Tools essential waf tools
|
2015-04-06 14:46:55 +02:00
|
|
|
waflib/extras contributed tools which are not included in the waf file by default
|
|
|
|
|
build_system_kit examples of build systems that can be created from Waf
|
2011-09-10 21:25:03 +02:00
|
|
|
tests various unit tests, most are unused anymore
|
2015-04-06 14:46:55 +02:00
|
|
|
playground experimental examples and test, most tools lie in the folder waflib/extras
|
|
|
|
|
demos integration tests - the folder can be configured as a standalone project
|
2011-09-10 11:13:51 +02:00
|
|
|
demos/* integration tests and examples used as documentation
|
|
|
|
|
docs documentation
|
2015-04-06 14:46:55 +02:00
|
|
|
docs/sphinx project extracting the docstrings from the source code to create the API documentation
|
2011-09-10 21:25:03 +02:00
|
|
|
|
2015-04-06 14:46:55 +02:00
|
|
|
Documentation
|
|
|
|
|
-------------------------------------------------
|
2011-09-10 21:25:03 +02:00
|
|
|
|
2016-06-24 13:21:32 +02:00
|
|
|
API documentation https://waf.io/apidocs/
|
|
|
|
|
The Waf Book https://waf.io/book/
|
2011-09-10 21:25:03 +02:00
|
|
|
|
2016-06-24 13:21:32 +02:00
|
|
|
General coding guidelines
|
|
|
|
|
-------------------------
|
2012-02-26 10:10:08 +01:00
|
|
|
|
2016-06-24 13:21:32 +02:00
|
|
|
* The code must run in both Python 2.6 to Python 3
|
|
|
|
|
* Use tabs for Python file indentation
|
2016-03-15 19:26:31 +01:00
|
|
|
* Use x.splitlines() instead of x.split('\n')
|
2016-06-24 13:21:32 +02:00
|
|
|
* Avoid "except:" and "except Exception:"
|
|
|
|
|
* Use Node.readf/Node.writef/Utils.readf/Utils.writef
|
|
|
|
|
|
|
|
|
|
Pull requests
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
See https://github.com/waf-project/waf
|
|
|
|
|
|
|
|
|
|
When implementing complex features, please add examples in the showcase folder demos/
|
|
|
|
|
for modules under waflib/Tools, under tests/ for platform-independent unit tests,
|
|
|
|
|
or in playground/ for modules under waflib/extras.
|
|
|
|
|
|
|
|
|
|
The files under waflib/Tools/ are kept API-compatible for the duration
|
|
|
|
|
of a middle version (currently 1.9).
|
2012-02-26 10:10:08 +01:00
|
|
|
|
