kernelnewbies.kernelnewbies.org archive mirror
 help / color / mirror / Atom feed
* [PATCH][kerneldoc] Remove non-functional DocBook "!D" tag
@ 2015-02-03 11:06 Robert P. J. Day
  0 siblings, 0 replies; only message in thread
From: Robert P. J. Day @ 2015-02-03 11:06 UTC (permalink / raw)
  To: kernelnewbies


Remove the description of the apparently long non-functional "!D"
kerneldoc directive, and the single place under DocBook that refers to
it, which is simply commented out, anyway. If someone someday wants to
make that directive functional, then a description of it can be added
back in.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  the warning that "!D" functionality is "not perfect" goes back to
2008, so it's fairly clear that no one is going to miss it.

diff --git a/Documentation/DocBook/networking.tmpl b/Documentation/DocBook/networking.tmpl
index 29df250..1c9c07a 100644
--- a/Documentation/DocBook/networking.tmpl
+++ b/Documentation/DocBook/networking.tmpl
@@ -61,9 +61,6 @@
 !Enet/core/gen_estimator.c
      </sect1>
      <sect1><title>SUN RPC subsystem</title>
-<!-- The !D functionality is not perfect, garbage has to be protected by comments
-!Dnet/sunrpc/sunrpc_syms.c
--->
 !Enet/sunrpc/xdr.c
 !Enet/sunrpc/svc_xprt.c
 !Enet/sunrpc/xprt.c
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index acbc1a3..12f2c57 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -343,9 +343,6 @@ collected from files listed in Documentation/DocBook/Makefile.
 !I<filename> is replaced by the documentation for functions that are
 _not_ exported using EXPORT_SYMBOL.

-!D<filename> is used to name additional files to search for functions
-exported using EXPORT_SYMBOL.
-
 !F<filename> <function [functions...]> is replaced by the
 documentation, in <filename>, for the functions listed.

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2015-02-03 11:06 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-02-03 11:06 [PATCH][kerneldoc] Remove non-functional DocBook "!D" tag Robert P. J. Day

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