All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mike Rapoport <rppt@linux.vnet.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>
Cc: linux-doc@vger.kernel.org, linux-mm@kvack.org,
	linux-kernel@vger.kernel.org,
	Mike Rapoport <rppt@linux.vnet.ibm.com>
Subject: [PATCH 1/7] mm/util: make strndup_user description a kernel-doc comment
Date: Wed, 25 Jul 2018 14:26:04 +0300	[thread overview]
Message-ID: <1532517970-16409-2-git-send-email-rppt@linux.vnet.ibm.com> (raw)
In-Reply-To: <1532517970-16409-1-git-send-email-rppt@linux.vnet.ibm.com>

The description of the strndup_user function misses '*' character at the
beginning of the comment to be proper kernel-doc. Add the missing
character.

Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
---
 mm/util.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/util.c b/mm/util.c
index 3351659..6809014 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -196,7 +196,7 @@ void *vmemdup_user(const void __user *src, size_t len)
 }
 EXPORT_SYMBOL(vmemdup_user);
 
-/*
+/**
  * strndup_user - duplicate an existing string from user space
  * @s: The string to duplicate
  * @n: Maximum number of bytes to copy, including the trailing NUL.
-- 
2.7.4


WARNING: multiple messages have this Message-ID (diff)
From: Mike Rapoport <rppt@linux.vnet.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Andrew Morton <akpm@linux-foundation.org>
Cc: linux-doc@vger.kernel.org, linux-mm@kvack.org,
	linux-kernel@vger.kernel.org,
	Mike Rapoport <rppt@linux.vnet.ibm.com>
Subject: [PATCH 1/7] mm/util: make strndup_user description a kernel-doc comment
Date: Wed, 25 Jul 2018 14:26:04 +0300	[thread overview]
Message-ID: <1532517970-16409-2-git-send-email-rppt@linux.vnet.ibm.com> (raw)
In-Reply-To: <1532517970-16409-1-git-send-email-rppt@linux.vnet.ibm.com>

The description of the strndup_user function misses '*' character at the
beginning of the comment to be proper kernel-doc. Add the missing
character.

Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
---
 mm/util.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/util.c b/mm/util.c
index 3351659..6809014 100644
--- a/mm/util.c
+++ b/mm/util.c
@@ -196,7 +196,7 @@ void *vmemdup_user(const void __user *src, size_t len)
 }
 EXPORT_SYMBOL(vmemdup_user);
 
-/*
+/**
  * strndup_user - duplicate an existing string from user space
  * @s: The string to duplicate
  * @n: Maximum number of bytes to copy, including the trailing NUL.
-- 
2.7.4

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  reply	other threads:[~2018-07-25 11:26 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-25 11:26 [PATCH 0/7] memory management documentation updates Mike Rapoport
2018-07-25 11:26 ` Mike Rapoport
2018-07-25 11:26 ` Mike Rapoport [this message]
2018-07-25 11:26   ` [PATCH 1/7] mm/util: make strndup_user description a kernel-doc comment Mike Rapoport
2018-07-25 11:26 ` [PATCH 2/7] mm/util: add kernel-doc for kvfree Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport
2018-07-25 11:26 ` [PATCH 3/7] docs/core-api: kill trailing whitespace in kernel-api.rst Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport
2018-07-25 11:26 ` [PATCH 4/7] docs/core-api: move *{str,mem}dup* to "String Manipulation" Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport
2018-07-25 11:26 ` [PATCH 5/7] docs/core-api: split memory management API to a separate file Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport
2018-07-25 12:05   ` Matthew Wilcox
2018-07-25 12:05     ` Matthew Wilcox
2018-07-25 13:30     ` Mike Rapoport
2018-07-25 13:30       ` Mike Rapoport
2018-07-25 11:26 ` [PATCH 6/7] docs/mm: make GFP flags descriptions usable as kernel-doc Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport
2018-07-25 11:26 ` [PATCH 7/7] docs/core-api: mm-api: add section about GFP flags Mike Rapoport
2018-07-25 11:26   ` Mike Rapoport

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=1532517970-16409-2-git-send-email-rppt@linux.vnet.ibm.com \
    --to=rppt@linux.vnet.ibm.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.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.