Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1419460

[docs-next PATCH 0/9] Documentation/sphinx follow-up

Show all headers | View raw

Hi Jon -

Thanks for merging the main Sphinx series! I greet you with another set
of patches on top. ;)

The main things here are reducing the noise on duplicate sections and
adding better support for extracting exported symbols when
EXPORT_SYMBOLs and kernel-doc are in separate files. And then there are
some drive-by cleanups and fixes on top.

I'm still working on rewriting Documentation/kernel-doc-nano-HOWTO.txt
to reflect all the changes, but didn't want to let these wait for that.

BR,
Jani.


PS. One wrinkle I spotted is that in the kernel-doc directive,
:functions: and :internal: also match structs and other types. This is
just kernel-doc the script shining its awesomeness through to the upper
layer; I just totally missed this earlier. I added :doc: to make the
distinction for documents, even though internally that uses kernel-doc
-function parameter as well.

Should we rename :functions: to, mmh, maybe :symbols: (for want of a
better word) while we still can, or leave that in as a historical
curiosity? I'm not sure there's much value in adding a separate :types:
(or something) for non-functions either? And should :internal: keep
returning non-functions as well? Or make that return just functions and
have another argument to get the types? Thoughts?


Jani Nikula (9):
  kernel-doc: remove old debug cruft from dump_section()
  kernel-doc: do not warn about duplicate default section names
  kernel-doc: add missing semi-colons in option parsing
  kernel-doc: abstract filename mapping
  kernel-doc: add support for specifying extra files for EXPORT_SYMBOLs
  kernel-doc: unify all EXPORT_SYMBOL scanning to one place
  Documentation/sphinx: remove unnecessary temporary variable
  Documentation/sphinx: use a more sensible string split in kernel-doc
    extension
  Documentation/sphinx: add support for specifying extra export files

 Documentation/sphinx/kernel-doc.py | 18 +++++---
 scripts/kernel-doc                 | 88 +++++++++++++++++++++++++++-----------
 2 files changed, 75 insertions(+), 31 deletions(-)

-- 
2.1.4

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[docs-next PATCH 0/9] Documentation/sphinx follow-up Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 3/9] kernel-doc: add missing semi-colons in option parsing Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 4/9] kernel-doc: abstract filename mapping Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 2/9] kernel-doc: do not warn about duplicate default section names Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 7/9] Documentation/sphinx: remove unnecessary temporary variable Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 1/9] kernel-doc: remove old debug cruft from dump_section() Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 9/9] Documentation/sphinx: add support for specifying extra export files Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200
  [docs-next PATCH 8/9] Documentation/sphinx: use a more sensible string split in kernel-doc extension Jani Nikula <jani.nikula@intel.com> - 2016-06-10 16:20 +0200

csiph-web