Re: [PATCH 02/17] sandbox: Add missing comments for os_alarm()

On 10/30/22 02:47, Simon Glass wrote:

Add the documentation to avoid a warning with 'make htmldocs'.

Fixes: 10107efedd5 ("sandbox: add SIGALRM-based watchdog device")

Signed-off-by: Simon Glass sjg@chromium.org

include/os.h | 4 ++++ 1 file changed, 4 insertions(+)

diff --git a/include/os.h b/include/os.h index 54874f5e0e8..0415f0f0e7a 100644 --- a/include/os.h +++ b/include/os.h @@ -110,6 +110,10 @@ void os_exit(int exit_code) __attribute__((noreturn));

/**

• os_alarm() - access to the OS alarm() system call

alarm() is not a system call but a POSIX function.

Best regards

Heinrich

• • @seconds: number of seconds before the signal is sent
• • Returns: number of seconds remaining until any previously scheduled alarm was
• • due to be delivered; 0 if there was no previously scheduled alarm
  */ unsigned int os_alarm(unsigned int seconds);