linux/Documentation/DocBook
Hans Verkuil 7e182f7898 [media] media.h: mark alsa struct in media_entity_desc as TODO
The alsa struct in struct media_entity_desc is now marked as deprecated.
However, the alsa struct should remain as it is since it cannot be replaced
by a simple major/minor device node description. The alsa struct was designed
to be used as an alsa card description so V4L2 drivers could use this to expose
the alsa card that they create to carry the captured audio. Such a card is not
just a PCM device, but also needs to contain the alsa subdevice information,
and it may map to multiple devices, e.g. a PCM and a mixer device, such as the
au0828 usb stick creates.

This is exactly as intended and this cannot and should not be replaced by a
simple major/minor.

However, whether this information is in the right form for an ALSA device such
that it can handle udev renaming rules as well is another matter. So mark this
alsa struct as TODO and document the problems involved.

Updated the documentation as well to reflect this and to add the 'major'
and 'minor' field documentation.

Updated the documentation to clearly state that struct dev is to be used for
(sub-)devices that create a single device node. Other devices need their own
structure here.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
2015-02-26 08:40:10 -03:00
..
media [media] media.h: mark alsa struct in media_entity_desc as TODO 2015-02-26 08:40:10 -03:00
.gitignore doc: Add "*.svg" to DocBook/.gitignore 2013-12-02 14:49:19 +01:00
80211.tmpl wireless: docs: fix 'make pdfdocs' failure 2015-01-28 08:53:58 +01:00
alsa-driver-api.tmpl ALSA: doc: Fix missing "I" for kerneldoc inclusion 2014-10-30 15:42:33 +01:00
crypto-API.tmpl Documentation: Fix trivial typo in comment. 2015-02-04 16:21:38 -05:00
debugobjects.tmpl
device-drivers.tmpl Fix docs build failure caused by i2o removal 2015-02-16 12:52:08 -07:00
deviceiobook.tmpl
drm.tmpl drm/i915/documentation: Add intel_uncore.c to drm.tmpl 2015-01-29 17:05:27 +01:00
filesystems.tmpl htmldocs: fix bio.c location 2014-05-20 08:17:35 -06:00
gadget.tmpl usb: patches for v3.17 merge window 2014-07-21 11:33:41 -07:00
genericirq.tmpl DocBook: fix various typos 2014-07-12 11:30:36 -07:00
kernel-api.tmpl DocBook: include !Emm/util.c in kernel-api to include, kzfree and more 2013-12-02 14:42:57 +01:00
kernel-hacking.tmpl Merge branch 'akpm' (incoming from Andrew) 2014-04-07 16:38:06 -07:00
kernel-locking.tmpl locking/Documentation: Move locking related docs into Documentation/locking/ 2014-08-13 10:32:03 +02:00
kgdb.tmpl KGDB/KDB New: 2015-02-20 15:13:29 -08:00
libata.tmpl DocBook: fix various typos 2014-07-12 11:30:36 -07:00
librs.tmpl
lsm.tmpl
Makefile DocBook: Do not exceed argument list limit 2015-01-28 11:33:44 -07:00
media_api.tmpl DocBook: fix various typos 2014-07-12 11:30:36 -07:00
mtdnand.tmpl DocBook: fix mtdnand typos 2014-07-12 11:30:36 -07:00
networking.tmpl docbook: networking: fix file paths for uapi headers 2012-10-15 08:04:41 -07:00
rapidio.tmpl
regulator.tmpl DocBook: fix various typos 2014-07-12 11:30:36 -07:00
s390-drivers.tmpl
scsi.tmpl
sh.tmpl
stylesheet.xsl
tracepoint.tmpl
uio-howto.tmpl pdfdocs: Fix 'make pdfdocs' failure for 'uio-howto.tmpl' 2015-02-03 15:48:51 -08:00
usb.tmpl usb: hub: rename khubd to hub_wq in documentation and comments 2014-09-23 22:33:19 -07:00
w1.tmpl w1: format for DocBook and fixes 2014-02-07 15:40:18 -08:00
writing_musb_glue_layer.tmpl documentation: docbook: document process of writing an musb glue layer 2014-05-12 12:34:47 -05:00
writing_usb_driver.tmpl doc: fix misspellings with 'codespell' tool 2013-05-28 12:02:12 +02:00
writing-an-alsa-driver.tmpl ALSA: doc: Recommend the use of snd_ctl_elem_info() 2014-10-20 18:06:04 +02:00
z8530book.tmpl