nathanwilliams-ct commented on code in PR #2202:
URL: https://github.com/apache/buildstream/pull/2202#discussion_r4348037830


##########
doc/source/format_intro.rst:
##########
@@ -245,13 +245,15 @@ author to assert some invalid configurations.
 
 .. _format_directives_list_prepend:
 
-(<) List Prepend
+(<) Prepend
 ~~~~~~~~~~~~~~~~
-Indicates that the list should be prepended to the target list,
-instead of the default behavior which is to replace the target list.
+Indicates that the value should be prepended to the targetted element.
+If we are applying it to a list it will insert the elements in the beginning.
+If we are applying it to a string, it will put the element string in front of 
the target's.
 
 **Example:**
 
+For lists:

Review Comment:
   While reviewing this it has reminded me, for these examples, I have always 
wanted something like below to help readers understand these features better.
   
   ---
   
   An element using `kind:autotools` will have the following default behaviour 
from the plugin:
   ```code::yaml
   config:
     configure-commands:
     - |
       %{autogen}
     - |
       %{configure}
   ```
   In the element, additional configure-commands can be set before the default 
ones like this:
   ```code::yaml
   kind:autotools
   **snip**
   config:
    configure-commands:
      (<):
        # Before configuring, lets make sure we're using
        # the latest config.sub & config.guess
        - cp %{datadir}/automake-*/config.{sub,guess} .
   **snip**
   ```
   which will result in the following being loaded and built by Buildstream:
   ```code::yaml
   kind:autotools
   **snip**
   config:
    configure-commands:
     # Before configuring, lets make sure we're using
     # the latest config.sub & config.guess
     - cp %{datadir}/automake-*/config.{sub,guess} .
     - |
       %{autogen}
     - |
       %{configure}
   **snip**
   ```
   ---
   but this is probably out of scope for this PR, so I'll open up a follow-up 
issue.
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to