linux-block.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] block: fix Sphinx kernel-doc warning
@ 2017-10-16 18:01 Randy Dunlap
  2017-10-16 19:01 ` Jens Axboe
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2017-10-16 18:01 UTC (permalink / raw)
  To: LKML, axboe, linux-block; +Cc: Andrew Morton

From: Randy Dunlap <rdunlap@infradead.org>

Sphinx treats symbols that end with '_' as a kind of special
documentation indicator, so fix that by adding an ending '*'
to it.

../block/bio.c:404: ERROR: Unknown target name: "gfp".

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 block/bio.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-414-rc5.orig/block/bio.c
+++ lnx-414-rc5/block/bio.c
@@ -400,7 +400,7 @@ static void punt_bios_to_rescuer(struct
 
 /**
  * bio_alloc_bioset - allocate a bio for I/O
- * @gfp_mask:   the GFP_ mask given to the slab allocator
+ * @gfp_mask:   the GFP_* mask given to the slab allocator
  * @nr_iovecs:	number of iovecs to pre-allocate
  * @bs:		the bio_set to allocate from.
  *

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] block: fix Sphinx kernel-doc warning
  2017-10-16 18:01 [PATCH] block: fix Sphinx kernel-doc warning Randy Dunlap
@ 2017-10-16 19:01 ` Jens Axboe
  0 siblings, 0 replies; 2+ messages in thread
From: Jens Axboe @ 2017-10-16 19:01 UTC (permalink / raw)
  To: Randy Dunlap, LKML, linux-block; +Cc: Andrew Morton

On 10/16/2017 12:01 PM, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Sphinx treats symbols that end with '_' as a kind of special
> documentation indicator, so fix that by adding an ending '*'
> to it.

Added for 4.15, thanks Randy.

-- 
Jens Axboe

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-10-16 19:01 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-10-16 18:01 [PATCH] block: fix Sphinx kernel-doc warning Randy Dunlap
2017-10-16 19:01 ` Jens Axboe

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).