[PATCH] cyclic: doc: Update documentation for CONFIG_CYCLIC_MAX_CPU_TIME_US

[Stefan Roese]

On 10/7/23 12:52, Weizhao Ouyang wrote:
> Cyclic now just print a warning once instead of disabling the cyclic
> function when the cyclic function upon exceeding CPU time usage.
> 
> Fixes: ddc8d36a7455 ("cyclic: Don't disable cylic function upon exceeding CPU time")
> Signed-off-by: Weizhao Ouyang <o451686892 at gmail.com>

Reviewed-by: Stefan Roese <sr at denx.de>

Thanks,
Stefan

> ---
>   doc/develop/cyclic.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/develop/cyclic.rst b/doc/develop/cyclic.rst
> index 43bedacb9f..be70a54f67 100644
> --- a/doc/develop/cyclic.rst
> +++ b/doc/develop/cyclic.rst
> @@ -11,8 +11,8 @@ on a high frequent polling (e.g. UART rx char ready check) might be
>   delayed too much. To detect cyclic functions with a too long execution
>   time, the Kconfig option `CONFIG_CYCLIC_MAX_CPU_TIME_US` is introduced,
>   which configures the max allowed time for such a cyclic function. If it's
> -execution time exceeds this time, this cyclic function will get removed
> -from the cyclic list.
> +execution time exceeds this time, cyclic will print a warning once to show
> +this potential problem to the user.
>   
>   Registering a cyclic function
>   -----------------------------

Viele Grüße,
Stefan Roese

-- 
DENX Software Engineering GmbH,      Managing Director: Erika Unter
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: sr at denx.de