diff options
| author | Heinrich Schuchardt | 2022-01-19 18:05:50 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt | 2022-01-19 18:11:34 +0100 |
| commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
| tree | 2fea02768d6005934547f075586c60ba7aca6253 /common/autoboot.c | |
| parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'common/autoboot.c')
| -rw-r--r-- | common/autoboot.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/common/autoboot.c b/common/autoboot.c index 6251c683108..b8861d56218 100644 --- a/common/autoboot.c +++ b/common/autoboot.c @@ -69,7 +69,7 @@ static int menukey; * before starting to enter the password. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_crypt(uint64_t etime) { @@ -143,7 +143,7 @@ static int slow_equals(u8 *a, u8 *b, int len) * This checks for the user entering a SHA256 hash within a given time. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_sha256(uint64_t etime) { @@ -219,7 +219,7 @@ static int passwd_abort_sha256(uint64_t etime) * This checks for the user entering a string within a given time. * * @etime: Timeout value ticks (stop when get_ticks() reachs this) - * @return 0 if autoboot should continue, 1 if it should stop + * Return: 0 if autoboot should continue, 1 if it should stop */ static int passwd_abort_key(uint64_t etime) { @@ -315,7 +315,7 @@ static void flush_stdin(void) * sha256-fallback has been enabled via the config setting * `AUTOBOOT_SHA256_FALLBACK`. * - * @return `false` if we must not fall-back, `true` if plain sha256 should be tried + * Return: `false` if we must not fall-back, `true` if plain sha256 should be tried */ static bool fallback_to_sha256(void) { |