Checkbox

Merge lp:~roadmr/checkbox/tp-doc-fixes into lp:checkbox

  1. tp-doc-fixes
  2. Merge into trunk
Proposed by Daniel Manrique
Status: Merged
Approved by: Sylvain Pineau
Approved revision: 3603
Merged at revision: 3603
Proposed branch: lp:~roadmr/checkbox/tp-doc-fixes
Merge into: lp:checkbox
Diff against target: 38 lines (+7/-7)
1 file modified
plainbox/docs/manpages/plainbox-test-plan-units.rst (+7/-7)
To merge this branch: bzr merge lp:~roadmr/checkbox/tp-doc-fixes
Reviewer Review Type Date Requested Status
Sylvain Pineau Approve
Review via email: mp+252004@code.launchpad.net

Commit message

plainbox:doc: some fixes to test-plan documentation

Description of the change

plainbox:doc: some fixes to test-plan documentation

To post a comment you must log in.
Revision history for this message
Sylvain Pineau (sylvain-pineau) wrote :

Good catch +1

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'plainbox/docs/manpages/plainbox-test-plan-units.rst'
2--- plainbox/docs/manpages/plainbox-test-plan-units.rst 2014-09-18 11:21:36 +0000
3+++ plainbox/docs/manpages/plainbox-test-plan-units.rst 2015-03-05 19:04:45 +0000
4@@ -10,9 +10,9 @@
5 Description
6 ===========
7
8-The template unit is an evolution of the Plainbox whitelist concept, that is,
9-a facility that describes a sequence of job definitions that should be
10-executed together.
11+The test plan unit is an evolution of the Plainbox whitelist concept, that is,
12+a facility that describes a sequence of job definitions that should be executed
13+together.
14
15 As in whitelists, jobs definitions are _selected_ by either listing their
16 identifier or a regular expression that matches their identifier. Selected
17@@ -34,9 +34,9 @@
18 -----------------
19
20 The following fields can be used in a test plan. Note that **not all** fields
21-need to be used or even should be used. Please remember that Checkbox needs
22-to maintain backwards compatibility so some of the test plans it defines may
23-non-typical constructs required ensure proper behavior. You don't have to
24+need to be used or even should be used. Please remember that Checkbox needs to
25+maintain backwards compatibility so some of the test plans it defines may have
26+non-typical constructs required to ensure proper behavior. You don't have to
27 copy such constructs when working on a new test plan from scratch
28
29 ``id``:
30@@ -227,7 +227,7 @@
31 Examples
32 --------
33
34-A simple test plan that selects a several jobs::
35+A simple test plan that selects several jobs::
36
37 id: foo-bar-and-froz
38 _name: Tests Foo, Bar and Froz

Subscribers

People subscribed via source and target branches