[PATCH 0/5] Better markup for GPU DocBook

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi all,

As you might know the markup improvements have been discussed at kernel summit:

https://lwn.net/Articles/662930/

Unfortunately it died in a bikeshed fest due to an alliance of people who think
docs are useless and you should just read code and others who didn't know how to
build the kerneldoc into something pretty. Oh well.

But I still want this, and Dave Airlie is ok with using it for drm kerneldoc as
long as I maintain the support. Plan is to merge the first patch to adjust
gpu.tmpl into drm properly, and keep everything else in topic/kerneldoc at

	git://anongit.freedesktop.org/drm-intel topic/kerneldoc

If you want to build pretty docs just install asciidoc and base your drm
documentation patches on top of drm-intel-nightly. That tree also includes all
of Dave's tree. Alternatively pull in the above topic branch.

Note that asciidoc is strictly optional, but without it the docbook will look a
bit bad since beyond paragraphs there won't be any additional formatting (like
tables, quoting for sourcecode snippets or lists).

Intel also has an autobuilder that pushes latest drm-intel-nightly docs to

    http://dri.freedesktop.org/docs/drm/

Cheers, Daniel

Daniel Vetter (2):
  scripts/kernel-doc: Use asciidoc instead of markdown
  drm: Enable markdown^Wasciidoc for gpu.tmpl

Danilo Cesar Lemes de Paula (3):
  drm/doc: Convert to markdown
  scripts/kernel-doc: Adding infrastructure for markdown support
  scripts/kernel-doc: Improve Markdown results

 Documentation/DocBook/Makefile     |  25 +++++---
 Documentation/DocBook/gpu.tmpl     |  86 --------------------------
 drivers/gpu/drm/drm_modes.c        |  12 ++--
 drivers/gpu/drm/drm_modeset_lock.c |  14 ++---
 drivers/gpu/drm/drm_prime.c        |  16 ++---
 drivers/gpu/drm/i915/i915_reg.h    |  48 +++++++--------
 scripts/docproc.c                  |  54 ++++++++++++-----
 scripts/kernel-doc                 | 120 ++++++++++++++++++++++++++++++++-----
 8 files changed, 203 insertions(+), 172 deletions(-)

-- 
2.5.1

_______________________________________________
dri-devel mailing list
dri-devel@xxxxxxxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/dri-devel




[Index of Archives]     [Linux DRI Users]     [Linux Intel Graphics]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]
  Powered by Linux