From bf5648fa9b62a663e3d68b2c5dde2b958b546b28 Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Fri, 21 Sep 2012 08:22:33 -0400 Subject: [PATCH] spelling and formatting --- master/docs/manual/cfg-properties.rst | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/master/docs/manual/cfg-properties.rst b/master/docs/manual/cfg-properties.rst index 1ae4e04b9d1..21aeea2ac11 100644 --- a/master/docs/manual/cfg-properties.rst +++ b/master/docs/manual/cfg-properties.rst @@ -108,9 +108,11 @@ Source Stamp Attributes ``repository`` ``project`` ``codebase`` - For details of these attributes see :ref:`Concepts`. + + For details of these attributes see :doc:`/manual/concepts`. ``changes`` + This attribute is a list of dictionaries reperesnting the changes that make up this sourcestamp. ``has_patch`` @@ -119,8 +121,8 @@ Source Stamp Attributes ``patch_subdir`` ``patch_author`` ``patch_comment`` - These attributes are set if the source stamp was created by a :ref:`try scheduler`. + These attributes are set if the source stamp was created by a :ref:`try scheduler`. Using Properties in Steps @@ -131,7 +133,9 @@ during a build. This is done by annotating the step definition in ``master.cfg`` with placeholders. When the step is executed, these placeholders will be replaced using the current values of the build properties. -.. note:: Properties are defined while a build is in progress; their values are +.. note:: + + Properties are defined while a build is in progress; their values are not available when the configuration file is parsed. This can sometimes confuse newcomers to Buildbot! In particular, the following is a common error:: @@ -250,14 +254,17 @@ Example :: from buildbot.steps.shell import ShellCommand from buildbot.process.properties import Interpolate - f.addStep(ShellCommand(command=[ 'make', Interpolate('REVISION=%(prop:got_revision:-%(src::revision:-unknwon)s)s') + f.addStep(ShellCommand(command=[ 'make', Interpolate('REVISION=%(prop:got_revision:-%(src::revision:-unknown)s)s') 'dist' ])) In addition, ``Interpolate`` supports using positional string interpolation. Here, ``%s`` is used as a placeholder, and the substitutions (which may themselves be placeholders), are given as subsequent arguments:: -.. note: like python, you can use either positional interpolation *or* dictionary-style interpolation, not both. -Thus you cannot use a string like ``Interpolate("foo-%(src::revision)s-%s", "branch")``. +.. note: + + Like python, you can use either positional interpolation *or* + dictionary-style interpolation, not both. Thus you cannot use a string + like ``Interpolate("foo-%(src::revision)s-%s", "branch")``. .. index:: single; Properties; WithProperties