waf.cygclass

Cygport Reference Manual

### TABLE OF CONTENTS

- waf.cygclass

- WAF
- waf_compile

- WAF_CONFIGURE_FLAGS
- WAF_BUILD_FLAGS

- waf_test

- WAF_TEST_FLAGS

- waf_install

- WAF_INSTALL_FLAGS

- src_compile (waf)
- src_install (waf)

## waf.cygclass

[ Top ] [ Cygclasses ] [ Cygclasses ]

SYNOPSIS

      inherit waf

DESCRIPTION

Waf is a general-purpose build system written in Python used by XMMS2, a few GTK+ programs, and some other projects. The build system is provided by a bundled 'waf' script in the top source directory, and is driven by a 'wscript' file in the top source directory and 'wscript_build' files in subdirectories, both of which are also written in Python.

NOTE

Previous versions uses to allow use of a system installed waf. This is no longer supported, as waf does not have a stable API and is therefore not feasibly used in this way. Fortunately, by now most packages do include a recent enough waf to build properly with at most only patches to 'wscript' and/or 'wscript_build' files.

REQUIRES

python

## WAF

[ Top ] [ waf.cygclass ] [ Definitions ]

DESCRIPTION

Path to the Waf command.

## waf_compile

[ Top ] [ waf.cygclass ] [ Compile Functions ]

SYNOPSIS

      waf_compile [OPTIONS]

DESCRIPTION

Runs 'waf configure' to configure the package, followed by 'waf build' to compile it. WAF_CONFIGURE_FLAGS and WAF_BUILD_FLAGS can be defined to pass additional arguments to the configure and build commands, respectively. Any arguments to waf_compile are passed as configure flags to the 'waf configure' command. waf_compile must be run from the directory containing 'wscript'.

## WAF_CONFIGURE_FLAGS

[ Top ] [ waf_compile ] [ Variables ]

DESCRIPTION

String containing additional arguments to pass to 'waf configure'.

## WAF_BUILD_FLAGS

[ Top ] [ waf_compile ] [ Variables ]

DESCRIPTION

String containing additional arguments to pass to 'waf build'.

## waf_test

[ Top ] [ waf.cygclass ] [ Testsuite Functions ]

DESCRIPTION

Runs the package's test suite with 'waf check'. WAF_TEST_FLAGS can be defined to pass additional arguments to the check command. Any arguments to waf_test are passed as well. waf_test must be run from the directory containing 'wscript'.

## WAF_TEST_FLAGS

[ Top ] [ waf_test ] [ Variables ]

DESCRIPTION

String containing additional arguments to pass to 'waf check'.

## waf_install

[ Top ] [ waf.cygclass ] [ Install Functions ]

DESCRIPTION

Installs the package into $D with 'waf install'. WAF_INSTALL_FLAGS can be defined to pass additional arguments to the install command. Any arguments to waf_install are passed as well. waf_install must be run from the directory containing 'wscript'.

## WAF_INSTALL_FLAGS

[ Top ] [ waf_install ] [ Variables ]

DESCRIPTION

String containing additional arguments to pass to 'waf install'.

## src_compile (waf)

[ Top ] [ waf.cygclass ] [ Overloads ]

DEFINITION

    src_compile() {
            lndirs
            cd ${B}
            waf_compile
    }

## src_install (waf)

[ Top ] [ waf.cygclass ] [ Overloads ]

DEFINITION

    src_install() {
            cd ${B}
            waf_install
    }