From: Daniel Vetter <daniel.vetter@ffwll.ch>
To: DRI Development <dri-devel@lists.freedesktop.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>,
Intel Graphics Development <intel-gfx@lists.freedesktop.org>
Subject: [PATCH 0/5] Better markup for GPU DocBook
Date: Wed, 25 Nov 2015 18:07:54 +0100 [thread overview]
Message-ID: <1448471279-19748-1-git-send-email-daniel.vetter@ffwll.ch> (raw)
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@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/dri-devel
next reply other threads:[~2015-11-25 17:08 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-11-25 17:07 Daniel Vetter [this message]
2015-11-25 17:07 ` [PATCH 1/5] drm/doc: Convert to markdown Daniel Vetter
2015-11-25 17:07 ` Daniel Vetter
2015-11-25 17:07 ` [PATCH 2/5] scripts/kernel-doc: Adding infrastructure for markdown support Daniel Vetter
2015-11-25 17:07 ` Daniel Vetter
2015-11-25 17:07 ` [PATCH 3/5] scripts/kernel-doc: Improve Markdown results Daniel Vetter
2015-11-25 17:07 ` Daniel Vetter
2015-11-25 17:07 ` [PATCH 4/5] scripts/kernel-doc: Use asciidoc instead of markdown Daniel Vetter
2015-12-02 9:34 ` [PATCH] " Daniel Vetter
2015-12-02 13:33 ` Jani Nikula
2015-12-02 15:32 ` Daniel Vetter
2015-12-02 15:57 ` Jani Nikula
2015-11-25 17:07 ` [PATCH 5/5] drm: Enable markdown^Wasciidoc for gpu.tmpl Daniel Vetter
2015-12-11 22:12 ` Jonathan Corbet
2015-12-12 11:13 ` Daniel Vetter
2016-01-12 1:12 ` Jonathan Corbet
2016-01-12 6:15 ` Jani Nikula
2016-01-12 8:34 ` Daniel Vetter
2016-01-12 11:06 ` Graham Whaley
2016-01-12 17:43 ` Daniel Vetter
2016-01-14 20:03 ` Jani Nikula
2016-01-14 20:18 ` Jonathan Corbet
2016-01-15 7:14 ` Jani Nikula
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1448471279-19748-1-git-send-email-daniel.vetter@ffwll.ch \
--to=daniel.vetter@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.