[yocto-docs PATCH] dev-manual: bblock: use warning block instead of attention

[yocto-docs PATCH] dev-manual: bblock: use warning block instead of attention

[Antonin Godard]

Sphinx recommends using warning and note here:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/bblock.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/dev-manual/bblock.rst b/documentation/dev-manual/bblock.rst
index 68292903bab039ad66936a5061887a0ed569dfb4..605bb75655242a1c9ec6dc0f5a1d5d472c4a7270 100644
--- a/documentation/dev-manual/bblock.rst
+++ b/documentation/dev-manual/bblock.rst
@@ -19,7 +19,7 @@ recipes that depend on it.
 To prevent this, use ``bblock`` to lock specific tasks or recipes to
 specific signatures, forcing BitBake to use the sstate cache for them.
 
-.. attention::
+.. warning::
 
    Use ``bblock`` only during the development phase.
 

---
base-commit: 2bfd49176ff71350054417dc6a9a284466876069
change-id: 20241113-remove-attention-set-warning-7f7b793cf817

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>

Re: [yocto-docs PATCH] dev-manual: bblock: use warning block instead of attention

[Quentin Schulz]

Hi Antonin,

On 11/14/24 4:02 PM, Antonin Godard wrote:
> Sphinx recommends using warning and note here:
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives
> 
> Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

I guess we could have had a commit with more changes in it. Except if 
your plan is to backport some to earlier releases maybe (since bblock 
isn't documented/supported in earlier releases)?

I think it'd be nice also to add this to the standard.md file we have so 
that people who take the time to read it would know to use these two 
only going forward?

Thanks!
Quentin

Re: [yocto-docs PATCH] dev-manual: bblock: use warning block instead of attention

[Antonin Godard]

Hi Quentin,

On Thu Nov 14, 2024 at 4:29 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/14/24 4:02 PM, Antonin Godard wrote:
>> Sphinx recommends using warning and note here:
>> https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives
>> 
>> Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> I guess we could have had a commit with more changes in it. Except if 
> your plan is to backport some to earlier releases maybe (since bblock 
> isn't documented/supported in earlier releases)?

It is: in styhead and scarthgap so this patch will be backported there.

> I think it'd be nice also to add this to the standard.md file we have so 
> that people who take the time to read it would know to use these two 
> only going forward?

Ack, I think it's a good idea as well. I'll try to send a patch :)

> Thanks!
> Quentin

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com