Mercurial > bitten > bitten-test
comparison doc/commands.txt @ 415:b4ec24092b54
Updated recipe command documentation.
| author | cmlenz |
|---|---|
| date | Wed, 08 Aug 2007 12:24:13 +0000 |
| parents | fa72698e7477 |
| children | ff35be7d2a5e |
comparison
equal
deleted
inserted
replaced
| 414:aa34d82b2c9a | 415:b4ec24092b54 |
|---|---|
| 2 | 2 |
| 3 ===================== | 3 ===================== |
| 4 Build Recipe Commands | 4 Build Recipe Commands |
| 5 ===================== | 5 ===================== |
| 6 | 6 |
| 7 Build recipes are represented by XML documents. This page describes what | 7 `Build recipes`_ are represented by XML documents. This page describes what |
| 8 commands are generally available in recipes. Please note, though, that | 8 commands are generally available in recipes. Please note, though, that |
| 9 third-party packages can add additional commands, which would then be | 9 third-party packages can add additional commands, which would then be |
| 10 documented by that third party. | 10 documented by that third party. |
| 11 | 11 |
| 12 .. _`build recipes`: recipes.html | |
| 13 | |
| 12 .. contents:: Contents | 14 .. contents:: Contents |
| 13 :depth: 2 | 15 :depth: 2 |
| 14 .. sectnum:: | 16 .. sectnum:: |
| 15 | 17 |
| 16 | 18 |
| 164 | 166 |
| 165 ./configure --enable-threadsafe CFLAGS="-O" | 167 ./configure --enable-threadsafe CFLAGS="-O" |
| 166 | 168 |
| 167 | 169 |
| 168 ------------ | 170 ------------ |
| 171 ``<c:gcov>`` | |
| 172 ------------ | |
| 173 | |
| 174 Run gcov_ to extract coverage data where available. | |
| 175 | |
| 176 .. _gcov: http://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html | |
| 177 | |
| 178 Parameters | |
| 179 ---------- | |
| 180 | |
| 181 +--------------+------------------------------------------------------------+ | |
| 182 | Name | Description | | |
| 183 +==============+============================================================+ | |
| 184 | ``include`` | List of glob patterns (separated by space) that specify | | |
| 185 | | which source files should be included in the coverage | | |
| 186 | | report | | |
| 187 +--------------+------------------------------------------------------------+ | |
| 188 | ``exclude`` | List of glob patterns (separated by space) that specify | | |
| 189 | | which source files should be excluded from the coverage | | |
| 190 | | report | | |
| 191 +--------------+------------------------------------------------------------+ | |
| 192 | ``prefix`` | Optional prefix name that is added to object files by the | | |
| 193 | | build system | | |
| 194 +--------------+------------------------------------------------------------+ | |
| 195 | |
| 196 | |
| 197 ------------ | |
| 169 ``<c:make>`` | 198 ``<c:make>`` |
| 170 ------------ | 199 ------------ |
| 171 | 200 |
| 172 Executes a Makefile. | 201 Executes a Makefile. |
| 173 | 202 |
| 271 | 300 |
| 272 Executes the target `compile` of the `build.xml` buildfile at the top of the | 301 Executes the target `compile` of the `build.xml` buildfile at the top of the |
| 273 project source directory. | 302 project source directory. |
| 274 | 303 |
| 275 | 304 |
| 305 -------------------- | |
| 306 ``<java:cobertura>`` | |
| 307 -------------------- | |
| 308 | |
| 309 Extract code coverage data from a Cobertura_ XML file. | |
| 310 | |
| 311 .. _cobertura: http://cobertura.sourceforge.net/ | |
| 312 | |
| 313 Parameters | |
| 314 ---------- | |
| 315 | |
| 316 +----------------+-----------------------------------------------------------+ | |
| 317 | Name | Description | | |
| 318 +================+===========================================================+ | |
| 319 | ``file`` | Path to the XML file generated by Cobertura | | |
| 320 +----------------+-----------------------------------------------------------+ | |
| 321 | |
| 322 Examples | |
| 323 -------- | |
| 324 | |
| 325 .. code-block:: xml | |
| 326 | |
| 327 <java:cobertura file="build/cobertura.xml" /> | |
| 328 | |
| 329 Reads the specifid XML file, extracts the coverage data, and builds a coverage | |
| 330 report to be sent to the build master. | |
| 331 | |
| 332 | |
| 276 ---------------- | 333 ---------------- |
| 277 ``<java:junit>`` | 334 ``<java:junit>`` |
| 278 ---------------- | 335 ---------------- |
| 279 | 336 |
| 280 Extracts information about unit test results from a file in JUnit_ XML format. | 337 Extracts information about unit test results from a file in JUnit_ XML format. |
| 386 .. code-block:: xml | 443 .. code-block:: xml |
| 387 | 444 |
| 388 <python:distutils command="sdist" /> | 445 <python:distutils command="sdist" /> |
| 389 | 446 |
| 390 Instructs `distutils` to produce a source distribution. | 447 Instructs `distutils` to produce a source distribution. |
| 448 | |
| 449 .. code-block:: xml | |
| 450 | |
| 451 <python:distutils command="unittest" options=" | |
| 452 --xml-output build/test-results.xml | |
| 453 --coverage-summary build/test-coverage.txt | |
| 454 --coverage-dir build/coverage"/> | |
| 455 | |
| 456 Instructs `distutils` to run the ``unittest`` command (which is provided by | |
| 457 Bitten), and passes the options needed to determine the output paths for test | |
| 458 results and code coverage reports. | |
| 391 | 459 |
| 392 | 460 |
| 393 --------------------- | 461 --------------------- |
| 394 ``<python:unittest>`` | 462 ``<python:unittest>`` |
| 395 --------------------- | 463 --------------------- |
| 479 .. code-block:: xml | 547 .. code-block:: xml |
| 480 | 548 |
| 481 <python:pylint file="build/pylint.out" /> | 549 <python:pylint file="build/pylint.out" /> |
| 482 | 550 |
| 483 | 551 |
| 552 Subversion Tools | |
| 553 ================ | |
| 554 | |
| 555 A collection of recipe commands for working with the Subversion_ version | |
| 556 control system. This commands are commonly used as the first step of a build | |
| 557 recipe to actually pull the code that should be built from the repository. | |
| 558 | |
| 559 .. _subversion: http://subversion.tigris.org/ | |
| 560 | |
| 561 :Namespace: ``http://bitten.cmlenz.net/tools/svn`` | |
| 562 :Common prefix: ``svn`` | |
| 563 | |
| 564 | |
| 565 ------------------ | |
| 566 ``<svn:checkout>`` | |
| 567 ------------------ | |
| 568 | |
| 569 Check out a working copy from a Subversion repository. | |
| 570 | |
| 571 Parameters | |
| 572 ---------- | |
| 573 | |
| 574 +--------------+-------------------------------------------------------------+ | |
| 575 | Name | Description | | |
| 576 +==============+=============================================================+ | |
| 577 | ``url`` | URL of the repository. | | |
| 578 +--------------+-------------------------------------------------------------+ | |
| 579 | ``path`` | The path inside the repository that should be checked out. | | |
| 580 | | You should normally set this to ``${path}`` so that the | | |
| 581 | | path of the build configuration is used. | | |
| 582 +--------------+-------------------------------------------------------------+ | |
| 583 | ``revision`` | The revision that should be checked out. You should | | |
| 584 | | normally set this to ``${revision}`` so that the revision | | |
| 585 | | of the build is used. | | |
| 586 +--------------+-------------------------------------------------------------+ | |
| 587 | |
| 588 Examples | |
| 589 -------- | |
| 590 | |
| 591 .. code-block:: xml | |
| 592 | |
| 593 <svn:checkout url="http://svn.example.org/repos/myproject/" | |
| 594 path="${path}" revision="${revision}"/> | |
| 595 | |
| 596 This checks out the a working copy into the current directory. | |
| 597 | |
| 598 | |
| 599 ---------------- | |
| 600 ``<svn:export>`` | |
| 601 ---------------- | |
| 602 | |
| 603 Download a file or directory from a Subversion repository. This is similar to | |
| 604 performing a checkout, but will not include the meta-data Subversion uses to | |
| 605 connect the local working copy to the repository (i.e. it does not include the | |
| 606 ``.svn`` directories.) | |
| 607 | |
| 608 Parameters | |
| 609 ---------- | |
| 610 | |
| 611 +--------------+-------------------------------------------------------------+ | |
| 612 | Name | Description | | |
| 613 +==============+=============================================================+ | |
| 614 | ``url`` | URL of the repository. | | |
| 615 +--------------+-------------------------------------------------------------+ | |
| 616 | ``path`` | The path inside the repository that should be checked out. | | |
| 617 | | You should normally set this to ``${path}`` so that the | | |
| 618 | | path of the build configuration is used. | | |
| 619 +--------------+-------------------------------------------------------------+ | |
| 620 | ``revision`` | The revision that should be checked out. You should | | |
| 621 | | normally set this to ``${revision}`` so that the revision | | |
| 622 | | of the build is used. | | |
| 623 +--------------+-------------------------------------------------------------+ | |
| 624 | |
| 625 Examples | |
| 626 -------- | |
| 627 | |
| 628 .. code-block:: xml | |
| 629 | |
| 630 <svn:export url="http://svn.example.org/repos/myproject/" | |
| 631 path="${path}" revision="${revision}"/> | |
| 632 | |
| 633 This downloads the file or directory at ``${path}`` from the Subversion | |
| 634 repository at ``http://svn.example.org/repos/myproject/``. Variables are used | |
| 635 for the ``path`` and ``revision`` attributes so they are populated from the | |
| 636 properties of the build and build configuration. | |
| 637 | |
| 638 | |
| 639 ---------------- | |
| 640 ``<svn:update>`` | |
| 641 ---------------- | |
| 642 | |
| 643 Update an existing working copy from a Subversion repository to a specific | |
| 644 revision. | |
| 645 | |
| 646 Parameters | |
| 647 ---------- | |
| 648 | |
| 649 +--------------+-------------------------------------------------------------+ | |
| 650 | Name | Description | | |
| 651 +==============+=============================================================+ | |
| 652 | ``revision`` | The revision that should be checked out. You should | | |
| 653 | | normally set this to ``${revision}`` so that the revision | | |
| 654 | | of the build is used. | | |
| 655 +--------------+-------------------------------------------------------------+ | |
| 656 | |
| 657 Examples | |
| 658 -------- | |
| 659 | |
| 660 .. code-block:: xml | |
| 661 | |
| 662 <svn:update revision="${revision}"/> | |
| 663 | |
| 664 This updates the working copy in the current directory. The revision is | |
| 665 specified as a variable so that it is populated from the properties of the | |
| 666 build. | |
| 667 | |
| 668 | |
| 484 XML Tools | 669 XML Tools |
| 485 ========= | 670 ========= |
| 486 | 671 |
| 487 A collection of recipe commands for XML processing. | 672 A collection of recipe commands for XML processing. |
| 488 | 673 |