bitbake-user-manual: update allowed characters in overrides

Message ID 20220307163354.531374-1-michael.opdenacker@bootlin.com
State Accepted, archived
Commit b12d4fe049c80fa6b042d5cd852b4d602221321d
Headers show
Series bitbake-user-manual: update allowed characters in overrides | expand

Commit Message

Michael Opdenacker March 7, 2022, 4:33 p.m. UTC
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---

 An open question is whether digits and/or hashes are
 allowed at the begining of an override keyword.
 Will be happy to send a V2 to explicit this if needed.

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

Comments

Quentin Schulz March 10, 2022, 10:27 a.m. UTC | #1
Hi Michael,

On 3/7/22 17:33, Michael Opdenacker via lists.openembedded.org wrote:
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
> 
>   An open question is whether digits and/or hashes are

I assume the question is about dashes (same question for underscores BTW).

>   allowed at the begining of an override keyword.
>   Will be happy to send a V2 to explicit this if needed.
> 
>   doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index b90e5cf0..104dcb6c 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -510,8 +510,8 @@ variable.
>   
>   .. note::
>   
> -   Overrides can only use lower-case characters. Additionally,
> -   colons are not permitted in override names as they are used to
> +   Overrides can only use lower-case characters, digits and dashes.

and underscores too!

Cheers,
Quentin

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index b90e5cf0..104dcb6c 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -510,8 +510,8 @@  variable.
 
 .. note::
 
-   Overrides can only use lower-case characters. Additionally,
-   colons are not permitted in override names as they are used to
+   Overrides can only use lower-case characters, digits and dashes.
+   In particular, colons are not permitted in override names as they are used to
    separate overrides from each other and from the variable name.
 
 -  *Selecting a Variable:* The :term:`OVERRIDES` variable is a