linux-kernel.vger.kernel.org archive mirror
 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 v5 12/13] buildid: Fix kernel-doc notation
Date: Tue, 20 Apr 2021 14:50:02 -0700	[thread overview]
Message-ID: <20210420215003.3510247-13-swboyd@chromium.org> (raw)
In-Reply-To: <20210420215003.3510247-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 a7edab4914e6..dfc62625cae4 100644
--- a/lib/buildid.c
+++ b/lib/buildid.c
@@ -121,7 +121,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-04-20 21:50 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-20 21:49 [PATCH v5 00/13] Add build ID to stacktraces Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 01/13] buildid: Only consider GNU notes for build ID parsing Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 02/13] buildid: Add API to parse build ID out of buffer Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 03/13] buildid: Stash away kernels build ID on init Stephen Boyd
2021-04-28 10:02   ` Baoquan He
2021-04-20 21:49 ` [PATCH v5 04/13] dump_stack: Add vmlinux build ID to stack traces Stephen Boyd
2021-04-26 11:04   ` Petr Mladek
2021-04-26 23:40     ` Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 05/13] module: Add printk formats to add module build ID to stacktraces Stephen Boyd
2021-04-21 11:49   ` Andy Shevchenko
2021-04-22 23:46     ` Stephen Boyd
2021-04-23 13:24       ` Andy Shevchenko
2021-04-23 13:45         ` Rasmus Villemoes
2021-04-23 14:08           ` Andy Shevchenko
2021-04-26 23:42         ` Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 06/13] arm64: stacktrace: Use %pSb for backtrace printing Stephen Boyd
2021-04-21  9:58   ` Catalin Marinas
2021-04-20 21:49 ` [PATCH v5 07/13] x86/dumpstack: Use %pSb/%pBb " Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 08/13] scripts/decode_stacktrace.sh: Support debuginfod Stephen Boyd
2021-04-20 21:49 ` [PATCH v5 09/13] scripts/decode_stacktrace.sh: Silence stderr messages from addr2line/nm Stephen Boyd
2021-04-20 21:50 ` [PATCH v5 10/13] scripts/decode_stacktrace.sh: Indicate 'auto' can be used for base path Stephen Boyd
2021-04-20 21:50 ` [PATCH v5 11/13] buildid: Mark some arguments const Stephen Boyd
2021-04-20 21:50 ` Stephen Boyd [this message]
2021-04-20 21:50 ` [PATCH v5 13/13] kdump: Use vmlinux_build_id to simplify Stephen Boyd
2021-04-28 10:13   ` Baoquan He
2021-04-28 23:14     ` Stephen Boyd
2021-05-07  3:54       ` Baoquan He
2021-05-07  4:04         ` Baoquan He

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=20210420215003.3510247-13-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).