[ptxdist] [PATCH] doc: fix rule file examples regarding suboptions

[ptxdist] [PATCH] doc: fix rule file examples regarding suboptions

[Markus Heidelberg via ptxdist]

Signed-off-by: Markus Heidelberg <m.heidelberg@cab.de>
---
 doc/dev_advanced_rule_files.rst | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/doc/dev_advanced_rule_files.rst b/doc/dev_advanced_rule_files.rst
index 26abf214d..55dc0e8f0 100644
--- a/doc/dev_advanced_rule_files.rst
+++ b/doc/dev_advanced_rule_files.rst
@@ -91,15 +91,17 @@ let’s expand our menu. Here is its current content:
               FIXME
 
 We’ll add two menu entries, one for each optional parameter we want to
-add on demand to the ``configure`` parameters:
+add on demand to the ``configure`` parameters. The main menu entry will be
+adapted to contain these entries in a submenu, trailing spaces are added to the
+``prompt`` string for proper alignment:
 
 .. code-block:: kconfig
 
     ## SECTION=project_specific
 
-    config FOO
+    menuconfig FOO
            tristate
-           prompt "foo"
+           prompt "foo                           "
            help
              FIXME
 
@@ -230,10 +232,10 @@ file looks like:
 
     ## SECTION=project_specific
 
-    config FOO
+    menuconfig FOO
            tristate
            select ZLIB
-           prompt "foo"
+           prompt "foo                           "
            help
              FIXME
 
@@ -269,11 +271,11 @@ enabled. To add these dependencies on demand, the menu file looks like:
 
     ## SECTION=project_specific
 
-    config FOO
+    menuconfig FOO
            tristate
            select ZLIB if FOO_FOO
            select LIBXML2 if FOO_BAR
-           prompt "foo"
+           prompt "foo                           "
            help
              FIXME
 
@@ -322,12 +324,12 @@ file. With all the additions above it now looks like:
 
     ## SECTION=project_specific
 
-    config FOO
+    menuconfig FOO
            tristate
            select ZLIB if FOO_FOO
            select LIBXML2 if FOO_BAR
            select LIBC_M
-           prompt "foo"
+           prompt "foo                           "
            help
              FIXME
 
-- 
2.43.0

Re: [ptxdist] [APPLIED] doc: fix rule file examples regarding suboptions

[Michael Olbrich]

Thanks, applied as c7a7ecaef4be34fb2e7508a60f751755f529e450.

Michael

[sent from post-receive hook]

On Fri, 23 Jan 2026 16:02:06 +0100, Markus Heidelberg <m.heidelberg@cab.de> wrote:
> Signed-off-by: Markus Heidelberg <m.heidelberg@cab.de>
> Message-Id: <20260113084523.88722-1-m.heidelberg@cab.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/dev_advanced_rule_files.rst b/doc/dev_advanced_rule_files.rst
> index 26abf214d141..55dc0e8f0a41 100644
> --- a/doc/dev_advanced_rule_files.rst
> +++ b/doc/dev_advanced_rule_files.rst
> @@ -91,15 +91,17 @@ let’s expand our menu. Here is its current content:
>                FIXME
>  
>  We’ll add two menu entries, one for each optional parameter we want to
> -add on demand to the ``configure`` parameters:
> +add on demand to the ``configure`` parameters. The main menu entry will be
> +adapted to contain these entries in a submenu, trailing spaces are added to the
> +``prompt`` string for proper alignment:
>  
>  .. code-block:: kconfig
>  
>      ## SECTION=project_specific
>  
> -    config FOO
> +    menuconfig FOO
>             tristate
> -           prompt "foo"
> +           prompt "foo                           "
>             help
>               FIXME
>  
> @@ -230,10 +232,10 @@ file looks like:
>  
>      ## SECTION=project_specific
>  
> -    config FOO
> +    menuconfig FOO
>             tristate
>             select ZLIB
> -           prompt "foo"
> +           prompt "foo                           "
>             help
>               FIXME
>  
> @@ -269,11 +271,11 @@ enabled. To add these dependencies on demand, the menu file looks like:
>  
>      ## SECTION=project_specific
>  
> -    config FOO
> +    menuconfig FOO
>             tristate
>             select ZLIB if FOO_FOO
>             select LIBXML2 if FOO_BAR
> -           prompt "foo"
> +           prompt "foo                           "
>             help
>               FIXME
>  
> @@ -322,12 +324,12 @@ file. With all the additions above it now looks like:
>  
>      ## SECTION=project_specific
>  
> -    config FOO
> +    menuconfig FOO
>             tristate
>             select ZLIB if FOO_FOO
>             select LIBXML2 if FOO_BAR
>             select LIBC_M
> -           prompt "foo"
> +           prompt "foo                           "
>             help
>               FIXME
>