From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Mon, 14 Nov 2022 09:25:04 +0000 (+0100)
Subject: doc: fix documentation of enum gd_flags
X-Git-Tag: v2025.01-rc5-pxa1908~1210^2~12
X-Git-Url: http://git.dujemihanovic.xyz/img/html/static/gitweb.css?a=commitdiff_plain;h=a8a0fc4628ba7a3443f4e90f47809fdac7aa492e;p=u-boot.git

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>
Reviewed-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Stefan Roese <sr@denx.de>
---

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,
 };