linux/Documentation/DocBook
Daniel Vetter 207fd32970 drm/fb-helper: improve kerneldoc
Now that the fbdev helper interface for drivers is trimmed down,
update the kerneldoc for all the remaining exported functions.

I've tried to beat the DocBook a bit by reordering the function
references a bit into a more sensible ordering. But that didn't work
out at all. Hence just extend the in-code DOC: section a bit.

Also remove the LOCKING: sections - especially for the setup functions
they're totally bogus. But that's not a documentation problem, but
simply an artifact of the current rather hazardous locking around drm
init and even more so around fbdev setup ...

v2: Some further improvements:
- Also add documentation for drm_fb_helper_single_add_all_connectors,
  Dave Airlie didn't want me to kill this one from the fb helper
  interface.
- Update docs for drm_fb_helper_fill_var/fix - they should be used
  from the driver's ->fb_probe callback to setup the fbdev info
  structure.
- Clarify what the ->fb_probe callback should all do - it needs to
  setup both the fbdev info and allocate the drm framebuffer used as
  backing storage.
- Add basic documentaation for the drm_fb_helper_funcs driver callback
  vfunc.

v3: Implement clarifications Laurent Pinchart suggested in his review.

v4: Fix another mispelling Laurent spotted.

Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2013-02-14 00:08:32 +01:00
..
media Documentation: remove __dev* attributes. 2013-01-03 15:57:16 -08:00
.gitignore [media] DocBook: Add a chapter to describe media errors 2011-07-27 17:53:35 -03:00
80211.tmpl mac80211: remove ieee80211_key_removed 2012-07-09 14:49:15 +02:00
Makefile MCA: delete all remaining traces of microchannel bus support. 2012-05-17 19:06:13 -04:00
alsa-driver-api.tmpl ALSA: Move ALSA docbooks to be with the rest of the kernel docbooks 2009-03-09 15:22:59 +01:00
debugobjects.tmpl debugobjects: Extend to assert that an object is initialized 2011-11-23 18:49:22 +01:00
device-drivers.tmpl Merge branch 'for-next' of git://gitorious.org/kernel-hsi/kernel-hsi 2012-04-02 09:50:40 -07:00
deviceiobook.tmpl docbook: change iomap source filename in deviceiobook 2012-01-23 08:44:54 -08:00
drm.tmpl drm/fb-helper: improve kerneldoc 2013-02-14 00:08:32 +01:00
filesystems.tmpl Documentation: get rid of write_super 2012-08-04 01:25:20 +04:00
gadget.tmpl usb: gadget: Remove File-backed Storage Gadget (g_file_storage). 2012-11-08 16:01:04 +02:00
genericirq.tmpl genirq: Update DocBook comments 2011-04-23 15:56:23 +02:00
kernel-api.tmpl kstrto*: add documentation 2012-12-17 17:15:22 -08:00
kernel-hacking.tmpl Documentation: Fix typo in multiple files in Documentation 2012-04-16 14:37:13 +02:00
kernel-locking.tmpl Fix common misspellings 2011-03-31 11:26:23 -03:00
kgdb.tmpl kgdb,debug_core: add the ability to control the reboot notifier 2012-03-22 15:07:16 -05:00
libata.tmpl Documentation: Fix typo in multiple files in Documentation 2012-04-16 14:37:13 +02:00
librs.tmpl
lsm.tmpl
media_api.tmpl [media] DocBook: various version/copyright year updates 2012-08-11 16:13:24 -03:00
mtdnand.tmpl mtd: nand: remove NAND_BBT_SEARCH option 2012-07-06 18:17:04 +01:00
networking.tmpl docbook: networking: fix file paths for uapi headers 2012-10-15 08:04:41 -07:00
rapidio.tmpl docbook: fix rapidio warning 2011-03-27 19:30:19 -07:00
regulator.tmpl Fix common misspellings 2011-03-31 11:26:23 -03:00
s390-drivers.tmpl docbook: fix s390 fatal error after header files moved 2008-08-05 16:56:29 -07:00
scsi.tmpl Documentation: update broken web addresses. 2010-08-04 15:21:40 +02:00
sh.tmpl sh: clkfwk: Kill off unused clk_set_rate_ex(). 2010-11-15 18:25:12 +09:00
stylesheet.xsl docbook: use IDs as filenames to support multiple books 2010-08-05 13:21:24 -07:00
tracepoint.tmpl workqueue: Add a workqueue chapter to the tracepoint docbook 2010-08-27 12:27:36 +02:00
uio-howto.tmpl drivers: uio_dmem_genirq: Don't use DMA_ERROR_CODE to indicate unmapped regions 2012-11-21 13:44:10 -08:00
usb.tmpl Fix common misspellings 2011-03-31 11:26:23 -03:00
writing-an-alsa-driver.tmpl ALSA: DocBook: Remove the description of __dev* 2012-12-07 07:53:38 +01:00
writing_usb_driver.tmpl USB: rename usb_buffer_alloc() and usb_buffer_free() users 2010-05-20 13:21:38 -07:00
z8530book.tmpl Rationalise Randy's address a bit 2008-10-30 11:38:47 -07:00