[PATCH 1/1] doc: fix documentation of enum gd_flags

Correct GD_FLG_CYCLIC_RUNNING documentation to match Sphinx style.
Fixes: d7de5ef62935 ("cyclic: use a flag in gd->flags for recursion protection") Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com --- include/asm-generic/global_data.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h index 02ad8ca595..88829126fb 100644 --- a/include/asm-generic/global_data.h +++ b/include/asm-generic/global_data.h @@ -651,7 +651,7 @@ enum gd_flags { */ GD_FLG_FDT_CHANGED = 0x100000, /** - * GD_FLG_CYCLIC_RUNNING: cyclic_run is in progress + * @GD_FLG_CYCLIC_RUNNING: cyclic_run is in progress */ GD_FLG_CYCLIC_RUNNING = 0x200000, };

On Mon, 14 Nov 2022 at 02:25, Heinrich Schuchardt heinrich.schuchardt@canonical.com wrote:
Correct GD_FLG_CYCLIC_RUNNING documentation to match Sphinx style.
Fixes: d7de5ef62935 ("cyclic: use a flag in gd->flags for recursion protection") Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
include/asm-generic/global_data.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Simon Glass sjg@chromium.org

On 14.11.22 10:25, Heinrich Schuchardt wrote:
Correct GD_FLG_CYCLIC_RUNNING documentation to match Sphinx style.
Fixes: d7de5ef62935 ("cyclic: use a flag in gd->flags for recursion protection") Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
Reviewed-by: Stefan Roese sr@denx.de
Thanks, Stefan
include/asm-generic/global_data.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h index 02ad8ca595..88829126fb 100644 --- a/include/asm-generic/global_data.h +++ b/include/asm-generic/global_data.h @@ -651,7 +651,7 @@ enum gd_flags { */ GD_FLG_FDT_CHANGED = 0x100000, /**
* GD_FLG_CYCLIC_RUNNING: cyclic_run is in progress
*/ GD_FLG_CYCLIC_RUNNING = 0x200000, };* @GD_FLG_CYCLIC_RUNNING: cyclic_run is in progress
Viele Grüße, Stefan Roese

On 14/11/2022 10.25, Heinrich Schuchardt wrote:
Correct GD_FLG_CYCLIC_RUNNING documentation to match Sphinx style.
Fixes: d7de5ef62935 ("cyclic: use a flag in gd->flags for recursion protection") Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
Ack, obviously.
But now that I look in global_data.h again, it struck me that GD_FLG_WDT_READY has become write-only since c2fd0ca1a822. That is, it is set in initr_watchdog but nothing ever test for it.
So we should probably remove that bit (and that line in initr_watchdog), and then fill the vacant spot with GD_FLG_CYCLIC_RUNNING.
Rasmus

Hi Rasmus,
On 15.11.22 13:10, Rasmus Villemoes wrote:
On 14/11/2022 10.25, Heinrich Schuchardt wrote:
Correct GD_FLG_CYCLIC_RUNNING documentation to match Sphinx style.
Fixes: d7de5ef62935 ("cyclic: use a flag in gd->flags for recursion protection") Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
Ack, obviously.
But now that I look in global_data.h again, it struck me that GD_FLG_WDT_READY has become write-only since c2fd0ca1a822. That is, it is set in initr_watchdog but nothing ever test for it.
So we should probably remove that bit (and that line in initr_watchdog), and then fill the vacant spot with GD_FLG_CYCLIC_RUNNING.
Good idea. I'll try to prepare a patch implementing this change tomorrow. Thanks for looking into this.
Thanks, Stefan
participants (4)
-
Heinrich Schuchardt
-
Rasmus Villemoes
-
Simon Glass
-
Stefan Roese