comparison doc/commands.txt @ 416:ff35be7d2a5e

Add PHP recipe commands contributed by Wei Zhuo.
author cmlenz
date Wed, 08 Aug 2007 12:43:16 +0000
parents b4ec24092b54
children 9d1631a751f8
comparison
equal deleted inserted replaced
415:b4ec24092b54 416:ff35be7d2a5e
364 Collects the test results from all files in the `build/tests/results` directory 364 Collects the test results from all files in the `build/tests/results` directory
365 that match the pattern `TEST-*.xml`. Also, maps the class names in the results 365 that match the pattern `TEST-*.xml`. Also, maps the class names in the results
366 files to Java source files in the directory `src/tests`. 366 files to Java source files in the directory `src/tests`.
367 367
368 368
369 PHP Tools
370 =========
371
372 A bundle of recipe commands for PHP_ projects.
373
374 :Namespace: ``http://bitten.cmlenz.net/tools/php``
375 :Common prefix: ``php``
376
377 .. _php: http://php.net/
378
379 ------------------
380 ``<python:phing>``
381 ------------------
382
383 Runs a Phing_ build.
384
385 .. _phing: http://phing.info/
386
387 Parameters
388 ----------
389
390 +-------------------+-------------------------------------------------------+
391 | Name | Description |
392 +===================+=======================================================+
393 | ``file`` | Path of the build file, relative to the project |
394 | | source directory (default is ``build.xml``). |
395 +-------------------+-------------------------------------------------------+
396 | ``target`` | Name of the build target(s) to execute. |
397 +-------------------+-------------------------------------------------------+
398 | ``args`` | Additional arguments to pass to Phing, separated by |
399 | | whitespace. |
400 +-------------------+-------------------------------------------------------+
401 | ``executable`` | Phing executable program (default is ``phing``). |
402 +-------------------+-------------------------------------------------------+
403
404
405 Examples
406 --------
407
408 .. code-block:: xml
409
410 <php:phing target="compile" />
411
412 Executes the target ``compile`` of the ``build.xml`` buildfile at the top of the
413 project source directory.
414
415
416 -----------------
417 ``<php:phpunit>``
418 -----------------
419
420 Extracts information from PHPUnit_ test results recorded in an XML file.
421
422 .. _phpunit: http://www.phpunit.de/
423
424 Parameters
425 ----------
426
427 +----------------+-----------------------------------------------------------+
428 | Name | Description |
429 +================+===========================================================+
430 | ``file`` | Path to the XML results file, relative to the project |
431 | | source directory. |
432 +----------------+-----------------------------------------------------------+
433
434 Examples
435 --------
436
437 .. code-block:: xml
438
439 <php:phpunit file="build/test-results.xml"/>
440
441 Extracts the test results from the XML file located at
442 ``build/test-results.xml``.
443
444
445 ------------------
446 ``<php:coverage>``
447 ------------------
448
449 Extracts coverage information Phing_'s code coverage task recorded in an XML
450 file.
451
452 Parameters
453 ----------
454
455 +---------------+-----------------------------------------------------------+
456 | Name | Description |
457 +===============+===========================================================+
458 | ``file`` | Path to the XML coverage file, relative to the project |
459 | | source directory. |
460 +---------------+-----------------------------------------------------------+
461
462 Examples
463 --------
464
465 .. code-block:: xml
466
467 <php:coverage file="build/coverage.xml" />
468
469
369 Python Tools 470 Python Tools
370 ============ 471 ============
371 472
372 A bundle of recipe commands that support tools commonly used by Python_ 473 A bundle of recipe commands that support tools commonly used by Python_
373 projects. 474 projects.
Copyright (C) 2012-2017 Edgewall Software