All of lore.kernel.org
 help / color / mirror / Atom feed
From: Stephen Boyd <swboyd@chromium.org>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: linux-kernel@vger.kernel.org, Jiri Olsa <jolsa@kernel.org>,
	Alexei Starovoitov <ast@kernel.org>, Jessica Yu <jeyu@kernel.org>,
	Evan Green <evgreen@chromium.org>,
	Hsin-Yi Wang <hsinyi@chromium.org>
Subject: [PATCH v3 11/12] buildid: Fix kernel-doc notation
Date: Tue, 30 Mar 2021 20:05:19 -0700	[thread overview]
Message-ID: <20210331030520.3816265-12-swboyd@chromium.org> (raw)
In-Reply-To: <20210331030520.3816265-1-swboyd@chromium.org>

Kernel doc should use "Return:" instead of "Returns" to properly reflect
the return values.

Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Jessica Yu <jeyu@kernel.org>
Cc: Evan Green <evgreen@chromium.org>
Cc: Hsin-Yi Wang <hsinyi@chromium.org>
Signed-off-by: Stephen Boyd <swboyd@chromium.org>
---
 lib/buildid.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/buildid.c b/lib/buildid.c
index e8a473f2b023..483abf71eeec 100644
--- a/lib/buildid.c
+++ b/lib/buildid.c
@@ -120,7 +120,7 @@ static int get_build_id_64(const void *page_addr, unsigned char *build_id,
  * @build_id: buffer to store build id, at least BUILD_ID_SIZE long
  * @size:     returns actual build id size in case of success
  *
- * Returns 0 on success, otherwise error (< 0).
+ * Return: 0 on success, -EINVAL otherwise
  */
 int build_id_parse(struct vm_area_struct *vma, unsigned char *build_id,
 		   __u32 *size)
-- 
https://chromeos.dev


  parent reply	other threads:[~2021-03-31  3:06 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-31  3:05 [PATCH v3 00/12] Add build ID to stacktraces Stephen Boyd
2021-03-31  3:05 ` Stephen Boyd
2021-03-31  3:05 ` Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 01/12] buildid: Add API to parse build ID out of buffer Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 02/12] buildid: Stash away kernels build ID on init Stephen Boyd
2021-03-31  3:05   ` Stephen Boyd
2021-04-08 12:05   ` Jessica Yu
2021-04-08 12:05     ` Jessica Yu
2021-04-08 18:52     ` Stephen Boyd
2021-04-08 18:52       ` Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 03/12] dump_stack: Add vmlinux build ID to stack traces Stephen Boyd
2021-04-07 13:42   ` Petr Mladek
2021-04-08  5:44     ` Stephen Boyd
2021-04-07 14:03   ` Petr Mladek
2021-04-08  1:14     ` Stephen Boyd
2021-04-08  6:20     ` Stephen Boyd
2021-04-08 10:13       ` Petr Mladek
2021-04-08 19:52         ` Stephen Boyd
2021-04-08 21:08           ` Stephen Boyd
2021-04-09  9:19           ` Petr Mladek
2021-03-31  3:05 ` [PATCH v3 04/12] module: Add printk format to add module build ID to stacktraces Stephen Boyd
2021-04-07 14:54   ` Petr Mladek
2021-04-07 15:07     ` Andy Shevchenko
2021-04-07 15:03   ` Petr Mladek
2021-04-07 15:37     ` Andy Shevchenko
2021-04-08  6:58     ` Stephen Boyd
2021-04-08 13:44   ` Jessica Yu
2021-04-08 14:05     ` Andy Shevchenko
2021-04-08 19:57       ` Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 05/12] arm64: stacktrace: Use %pSb for backtrace printing Stephen Boyd
2021-03-31  3:05   ` Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 06/12] x86/dumpstack: " Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 07/12] scripts/decode_stacktrace.sh: Support debuginfod Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 08/12] scripts/decode_stacktrace.sh: Silence stderr messages from addr2line/nm Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 09/12] scripts/decode_stacktrace.sh: Indicate 'auto' can be used for base path Stephen Boyd
2021-03-31  3:05 ` [PATCH v3 10/12] buildid: Mark some arguments const Stephen Boyd
2021-03-31  3:05 ` Stephen Boyd [this message]
2021-03-31  3:05 ` [PATCH v3 12/12] kdump: Use vmlinux_build_id to simplify Stephen Boyd
2021-03-31  3:05   ` Stephen Boyd
2021-04-07 17:03   ` Petr Mladek
2021-04-07 17:03     ` Petr Mladek
2021-04-08  5:36     ` Stephen Boyd
2021-04-08  5:36       ` Stephen Boyd
2021-04-08 10:17     ` Baoquan He
2021-04-08 10:17       ` Baoquan He
2021-04-08 19:58       ` Stephen Boyd
2021-04-08 19:58         ` Stephen Boyd

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210331030520.3816265-12-swboyd@chromium.org \
    --to=swboyd@chromium.org \
    --cc=akpm@linux-foundation.org \
    --cc=ast@kernel.org \
    --cc=evgreen@chromium.org \
    --cc=hsinyi@chromium.org \
    --cc=jeyu@kernel.org \
    --cc=jolsa@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.