lkml.org 
[lkml]   [2019]   [Apr]   [5]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH 0/4] docs: add support for :nosymbols:
Date
Linux's kernel-doc directive for Sphinx allows .rst files to selectively
include "functions", i.e. symbols, but does not allow .rst files to
explicitly exclude symbols. The actual kernel-doc script already
supports excluding symbols, i.e. most of the plumbing is in place, but
needs a bit of cleanup to get things working.

The intended user of this is SGX, which introduces a uapi header that
defines structs for ioctls and for a new vDSO function. Ideally, the
documentation for the vDSO struct will be placed into a different
section.

I'm sending this as a standalone series as the SGX patch set is already
ridiculously big[1], but I can fold these patches into the SGX series
if that's preferred.

[1] https://lkml.kernel.org/r/20190320162119.4469-1-jarkko.sakkinen@linux.intel.com


Sean Christopherson (4):
kernel-doc: Revert "scripts/kernel-doc: Processing -nofunc for
functions only"
kernel-doc: Rename -nofunction option to -nosymbol
kernel-doc: Rename -function to -symbol
docs: sphinx: Add support :nosymbols: to exclude specific symbols

Documentation/sphinx/kerneldoc.py | 9 +++++++--
scripts/kernel-doc | 19 ++++++++++---------
2 files changed, 17 insertions(+), 11 deletions(-)

--
2.21.0

\
 
 \ /
  Last update: 2019-04-05 23:45    [W:0.058 / U:10.584 seconds]
©2003-2018 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site