[bitbake-devel] [PATCH v2] user-manual-metadata: Clarify functionality of task flag 'dirs'.

[Martin Samuelsson]

Signed-off-by: Martin Samuelsson <martin.samuelsson at axis.com>
---
I've seen no response to this. With this being my first attempt at making a 
contribution to bitbake, I would appreciate any feedback. Is something e.g. 
problematic with the patch?

Please note that in the current state of documentation the two flags 'dirs' 
and 'cleandirs' are very similar in their description. Yet the flags are not 
all that similar. It is easy to get (and I got) the impression that they are 
functionally interchangeable with exception from that 'cleandirs' creates 
clean directories. The fact that 'dirs' points out the work dir to be used, 
while 'cleandirs' does not, is quite unexpected and should be important 
enough to be explicitly stated.

Bonus in this patch version. Typo fix in description of cleandirs.

 doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 1b9d800..c242653 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -1214,7 +1214,7 @@
             functionality of the task:
             <itemizedlist>
                 <listitem><para><emphasis>cleandirs:</emphasis>
-                    Empty directories that should created before the task runs.
+                    Empty directories that should be created before the task runs.
                     </para></listitem>
                 <listitem><para><emphasis>depends:</emphasis>
                     Controls inter-task dependencies.
@@ -1233,7 +1233,9 @@
                     section for more information.
                     </para></listitem>
                 <listitem><para><emphasis>dirs:</emphasis>
-                    Directories that should be created before the task runs.
+                    Directories that should be created before the task runs. The
+                    last directory listed will be used as the work directory for the
+                    task.
                     </para></listitem>
                 <listitem><para><emphasis>lockfiles:</emphasis>
                      Specifies one or more lockfiles to lock while the task
-- 
2.1.4