Skip to contentSkip to conversation

Doc: MODULE_SUPPORTED_DEVICE is not implemented

PATCH In review Paul Bolle 2 participants 3 messages Jun 19, 2015 – Jun 22, 2015 Documentation

lore
Share & tools
lore

Paul Bolle

author
#0 lore raw

PATCH 1/1 Doc: MODULE_SUPPORTED_DEVICE is not implemented

The MODULE_SUPPORTED_DEVICE macro is documented as
Not Yet Implemented

for over a decade now. It will clearly never be implemented. Remove a reference to it from a DocBook template.

---
Module "classes"? I removed that too.

Running "make xmldocs" always ends with
make[1]: *** No rule to make target `xmldocs'. Stop.
make: *** [xmldocs] Error 2

for me. But writing-an-alsa-driver.xml was generated just fine, so that must be something unrelated.

 Documentation/DocBook/writing-an-alsa-driver.tmpl | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
Documentation/DocBook/writing-an-alsa-driver.tmpl +3 -5
index 84ef6a90131c..6a2a346b4a22 100644
@@ -5896,17 +5896,15 @@ struct _snd_pcm_runtime {
     </para>
 
     <para>
-      Also, don't forget to define the module description, classes,
-      license and devices. Especially, the recent modprobe requires to
-      define the module license as GPL, etc., otherwise the system is
-      shown as <quote>tainted</quote>. 
+      Also, don't forget to define the module description, and license.
+      Especially, the recent modprobe requires to define the module license as
+      GPL, etc., otherwise the system is shown as <quote>tainted</quote>.
 
       <informalexample>
         <programlisting>
 <![CDATA[
   MODULE_DESCRIPTION("My Chip");
   MODULE_LICENSE("GPL");
-  MODULE_SUPPORTED_DEVICE("{{Vendor,My Chip Name}}");
 ]]>
         </programlisting>
       </informalexample>
Signature · 5 lines
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
Please read the FAQ at  http://www.tux.org/lkml/
maintainer
#1 lore raw
Quoted 5 lines · On Fri, 19 Jun 2015 16:10:25 +0200 Paul Bolle <[email protected]> wrote:

The MODULE_SUPPORTED_DEVICE macro is documented as
Not Yet Implemented

for over a decade now. It will clearly never be implemented. Remove a reference to it from a DocBook template.

The thing is, there's nearly 200 invocations of this macro in the tree. Taking out the documentation reference just makes those even more mysterious than they already are. I'd favor, instead, either (1) making the document state explicitly that this macro does nothing, or (2) a tree-wide patch simply removing it entirely.

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in Please read the FAQ at http://www.tux.org/lkml/

author
#2 lore raw
Quoted 3 lines · Jonathan Corbet

Taking out the documentation reference just makes those even more mysterious than they already are. I'd favor, instead, either (1) making the document state explicitly that this macro does nothing,

Perhaps the commit explanation was unclear here: did you spot that this is just some random template, not the template that is supposed to document the various module related macros, if such a template even exists.

Quoted 2 lines

or (2) a
tree-wide patch simply removing it entirely.

See http://lkml.kernel.org/r/1434723861.2385.152.camel@x220 . So that's already being worked on.

Thanks,

Paul Bolle
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in Please read the FAQ at http://www.tux.org/lkml/