[PATCH 0/1] yocto-bsp doc update

[PATCH 0/1] yocto-bsp doc update

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

This patch updates the documentation to match changes made for [YOCTO #2222].

The following changes since commit 2ddf7d3e8326e8cb07101ddb2d6e5dc6866371e2:
  Richard Purdie (1):
        gcc-configure-common.inc: Stop gcc looking at build system paths

are available in the git repository at:

  git://git.yoctoproject.org/poky-contrib.git tzanussi/2222-doc-fix
  http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=tzanussi/2222-doc-fix

Tom Zanussi (1):
  yocto-bsp: update help to match property list changes

 scripts/lib/bsp/help.py |   48 +++++++++++++++++++++++++++-------------------
 1 files changed, 28 insertions(+), 20 deletions(-)

[PATCH 1/1] yocto-bsp: update help to match property list changes

[tom.zanussi]

From: Tom Zanussi <tom.zanussi@intel.com>

The interface to the 'list properties' command changed to allow nested
properties, along with some changes to the property names used in the
documentation.  Update the help text to match.

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
---
 scripts/lib/bsp/help.py |   48 +++++++++++++++++++++++++++-------------------
 1 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/scripts/lib/bsp/help.py b/scripts/lib/bsp/help.py
index f78b09b..d7c1e8f 100644
--- a/scripts/lib/bsp/help.py
+++ b/scripts/lib/bsp/help.py
@@ -246,18 +246,14 @@ DESCRIPTION
     "kernel_choice" : {
         "prio" : 10
         "default" : linux-yocto_3.2
-        "depends-on" : use_default_kernel
-        "depends-on-val" : n
         "msg" : Please choose the kernel to use in this BSP =>
         "type" : choicelist
         "gen" : bsp.kernel.kernels
     }
     "if kernel_choice == "linux-yocto_3.0":" : {
-        "base_kbranch_linux_yocto_3_0" : {
+        "new_kbranch" : {
             "prio" : 20
             "default" : yocto/standard
-            "depends-on" : new_kbranch_linux_yocto_3_0
-            "depends-on-val" : y
             "msg" : Please choose a machine branch to base this BSP on =>
             "type" : choicelist
             "gen" : bsp.kernel.all_branches
@@ -269,20 +265,16 @@ DESCRIPTION
     Each entry in the output consists of the name of the input element
     e.g. "touchscreen", followed by the properties defined for that
     element enclosed in braces.  This information should provide
-    sufficient information to create a complete user interface with.
-    Two features of the scheme provide for conditional input.  First,
-    if a Python "if" statement appears in place of an input element
-    name, the set of enclosed input elements apply and should be
-    presented to the user only if the 'if' statement evaluates to
-    true.  The test in the if statement will always reference another
-    input element in the list, which means that the element being
-    tested should be presented to the user before the elements
-    enclosed by the if block.  Secondly, in a similar way, some
-    elements contain "depends-on" and depends-on-val" tags, which mean
-    that the affected input element should only be presented to the
-    user if the element it depends on has already been presented to
-    the user and the user has selected the specified value for that
-    element.
+    sufficient information with which to create a complete user
+    interface.  Conditional input can be provided by enclosing other
+    elements within a Python "if" statement.  If a Python "if"
+    statement appears in place of an input element name, the set of
+    enclosed input elements apply and should be presented to the user
+    only if the "if" statement evaluates to true.  The test in the
+    "if" statement will always reference another input element in the
+    list, which means that the element being tested should be
+    presented to the user before the elements enclosed by the if
+    block.
 
     The third form enumerates all the possible values that exist and
     can be specified for any of the enumerable properties of the given
@@ -298,7 +290,19 @@ DESCRIPTION
         ["xserver_emgd", "EMGD xserver support (proprietary)"]
         ["xserver_i915", "i915 xserver support"]
 
-    $ yocto-bsp list arm property base_kbranch_linux_yocto_3_0
+    In order to allow nested properties to be unambiguously specified,
+    standard JSON '.' notation is supported.  For example, to name the
+    'base_kbranch' property in the listing above, the full
+    specification would be:
+
+    $ yocto-bsp list i386 property "if kernel_choice == "linux-yocto_3.2":".new_kbranch
+
+    However, as a usability feature, a subset of the top-level
+    property can also be specified instead.  It will return the first
+    match, so the subset should be unique.  Here specifying just the
+    kernel name produces the desired result:
+
+    $ yocto-bsp list i386 property "linux-yocto_3.0".new_kbranch
         Getting branches from remote repo git://git.yoctoproject.org/linux-yocto-3.0...
         ["yocto/base", "yocto/base"]
         ["yocto/eg20t", "yocto/eg20t"]
@@ -316,6 +320,10 @@ DESCRIPTION
         ["yocto/standard/qemu-ppc32", "yocto/standard/qemu-ppc32"]
         ["yocto/standard/routerstationpro", "yocto/standard/routerstationpro"]
 
+    Note that because the property separator is '.', if a portion of
+    the nested property itself contains a '.', that part of the nested
+    property should be enclosed in double quotes.
+
     The third form as well is meant mainly for developers of
     alternative interfaces - it allows the developer to fetch the
     possible values for a given input element on-demand.  This
-- 
1.7.0.4