Merge lp:~kissiel/checkbox/manpages-update into lp:checkbox

[Maciej Kisielewski]

This MR extends job-unit manpage by adding note about 'imports' field.

7333301 plainbox:docs: add info about 'imports' field to job unit manpage

[Zygmunt Krynicki (zyga)]

Nice, just two small suggestions.

[lp:~kissiel/checkbox/manpages-update]

3590. By Maciej Kisielewski on 2015-03-03

plainbox:docs: add info about 'imports' field to job unit manpage

Signed-off-by: Maciej Kisielewski <email address hidden>

[Maciej Kisielewski (kissiel)]

> Nice, just two small suggestions.

Updated, amended, pushed.

[Zygmunt Krynicki (zyga)]

+1, thanks

review: Approve

=== modified file 'plainbox/docs/manpages/plainbox-job-units.rst'
--- plainbox/docs/manpages/plainbox-job-units.rst	2015-02-09 14:14:32 +0000
+++ plainbox/docs/manpages/plainbox-job-units.rst	2015-03-03 12:35:28 +0000
@@ -243,6 +243,25 @@
 
     Additional flags may be present in job definition; they are ignored.
 
+``imports``:
+    (optional) This field lists all the resource jobs that will have to be
+    imported from other namespaces. This enables jobs to use resources from
+    other namespaces.
+    You can use the "as ..." syntax to import jobs that have dashes, slashes or
+    other characters that would make them invalid as identifiers and give them
+    a correct identifier name. E.g.:
+
+      | imports: from 2013.com.canonical.certification import cpuinfo
+      | requires: 'armhf' in cpuinfo.platform
+
+      | imports: from 2013.com.canonical.certification import cpu-01-info as \
+        cpu01
+      | requires: 'avx2' in cpu01.other
+
+    The syntax of each imports line is:
+    IMPORT_STMT :: "from" <NAMESPACE> "import" <PARTIAL_ID>
+                   | "from" <NAMESPACE> "import" <PARTIAL_ID> AS <IDENTIFIER>
+
 ===========================
 Extension of the job format
 ===========================