From: Graham Whaley <graham.whaley@linux.intel.com>
To: daniel.vetter@intel.com, jani.nikula@linux.intel.com,
intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org
Cc: Graham Whaley <graham.whaley@linux.intel.com>,
danilo.cesar@collabora.co.uk, corbet@lwn.net
Subject: [PATCH 2/5] Documentation: drm: Fix pdfdocs listitem and abstract <para>s
Date: Tue, 25 Aug 2015 10:26:42 +0100 [thread overview]
Message-ID: <1440494805-13325-3-git-send-email-graham.whaley@linux.intel.com> (raw)
In-Reply-To: <1440494805-13325-1-git-send-email-graham.whaley@linux.intel.com>
Fix pdfdocs errors such as:
jade:/Documentation/DocBook/drm.xml:1348:20:E: character data is not
allowed here
by adding <para> tags to listitems and abstracts
Signed-off-by: Graham Whaley <graham.whaley@linux.intel.com>
---
Documentation/DocBook/drm.tmpl | 87 +++++++++++++++++++++++-------------------
1 file changed, 48 insertions(+), 39 deletions(-)
diff --git a/Documentation/DocBook/drm.tmpl b/Documentation/DocBook/drm.tmpl
index 586f1b8..952eb78 100644
--- a/Documentation/DocBook/drm.tmpl
+++ b/Documentation/DocBook/drm.tmpl
@@ -579,9 +579,9 @@ char *date;</synopsis>
<para>
On a fundamental level, GEM involves several operations:
<itemizedlist>
- <listitem>Memory allocation and freeing</listitem>
- <listitem>Command execution</listitem>
- <listitem>Aperture management at command execution time</listitem>
+ <listitem><para>Memory allocation and freeing</para></listitem>
+ <listitem><para>Command execution</para></listitem>
+ <listitem><para>Aperture management at command execution time</para></listitem>
</itemizedlist>
Buffer object allocation is relatively straightforward and largely
provided by Linux's shmem layer, which provides memory to back each
@@ -1386,20 +1386,20 @@ int max_width, max_height;</synopsis>
<para>
The DRM core recognizes three types of planes:
<itemizedlist>
- <listitem>
+ <listitem><para>
DRM_PLANE_TYPE_PRIMARY represents a "main" plane for a CRTC. Primary
planes are the planes operated upon by CRTC modesetting and flipping
operations described in <xref linkend="drm-kms-crtcops"/>.
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_PLANE_TYPE_CURSOR represents a "cursor" plane for a CRTC. Cursor
planes are the planes operated upon by the DRM_IOCTL_MODE_CURSOR and
DRM_IOCTL_MODE_CURSOR2 ioctls.
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_PLANE_TYPE_OVERLAY represents all non-primary, non-cursor planes.
Some drivers refer to these types of planes as "sprites" internally.
- </listitem>
+ </para></listitem>
</itemizedlist>
For compatibility with legacy userspace, only overlay planes are made
available to userspace by default. Userspace clients may set the
@@ -1503,22 +1503,22 @@ int max_width, max_height;</synopsis>
<function>drm_encoder_init</function>. The function takes a pointer to
the encoder functions and an encoder type. Supported types are
<itemizedlist>
- <listitem>
+ <listitem><para>
DRM_MODE_ENCODER_DAC for VGA and analog on DVI-I/DVI-A
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_MODE_ENCODER_TMDS for DVI, HDMI and (embedded) DisplayPort
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_MODE_ENCODER_LVDS for display panels
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_MODE_ENCODER_TVDAC for TV output (Composite, S-Video, Component,
SCART)
- </listitem>
- <listitem>
+ </para></listitem>
+ <listitem><para>
DRM_MODE_ENCODER_VIRTUAL for virtual machine displays
- </listitem>
+ </para></listitem>
</itemizedlist>
</para>
<para>
@@ -1635,21 +1635,21 @@ int max_width, max_height;</synopsis>
<para>
Supported connector types are
<itemizedlist>
- <listitem>DRM_MODE_CONNECTOR_VGA</listitem>
- <listitem>DRM_MODE_CONNECTOR_DVII</listitem>
- <listitem>DRM_MODE_CONNECTOR_DVID</listitem>
- <listitem>DRM_MODE_CONNECTOR_DVIA</listitem>
- <listitem>DRM_MODE_CONNECTOR_Composite</listitem>
- <listitem>DRM_MODE_CONNECTOR_SVIDEO</listitem>
- <listitem>DRM_MODE_CONNECTOR_LVDS</listitem>
- <listitem>DRM_MODE_CONNECTOR_Component</listitem>
- <listitem>DRM_MODE_CONNECTOR_9PinDIN</listitem>
- <listitem>DRM_MODE_CONNECTOR_DisplayPort</listitem>
- <listitem>DRM_MODE_CONNECTOR_HDMIA</listitem>
- <listitem>DRM_MODE_CONNECTOR_HDMIB</listitem>
- <listitem>DRM_MODE_CONNECTOR_TV</listitem>
- <listitem>DRM_MODE_CONNECTOR_eDP</listitem>
- <listitem>DRM_MODE_CONNECTOR_VIRTUAL</listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_VGA</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_DVII</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_DVID</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_DVIA</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_Composite</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_SVIDEO</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_LVDS</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_Component</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_9PinDIN</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_DisplayPort</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_HDMIA</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_HDMIB</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_TV</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_eDP</para></listitem>
+ <listitem><para>DRM_MODE_CONNECTOR_VIRTUAL</para></listitem>
</itemizedlist>
</para>
<para>
@@ -3612,7 +3612,10 @@ void (*lastclose) (struct drm_device *);
int (*open) (struct drm_device *, struct drm_file *);
void (*preclose) (struct drm_device *, struct drm_file *);
void (*postclose) (struct drm_device *, struct drm_file *);</synopsis>
- <abstract>Open and close handlers. None of those methods are mandatory.
+ <abstract>
+ <para>
+ Open and close handlers. None of those methods are mandatory.
+ </para>
</abstract>
<para>
The <methodname>firstopen</methodname> method is called by the DRM core
@@ -3667,7 +3670,11 @@ void (*postclose) (struct drm_device *, struct drm_file *);</synopsis>
<sect2>
<title>File Operations</title>
<synopsis>const struct file_operations *fops</synopsis>
- <abstract>File operations for the DRM device node.</abstract>
+ <abstract>
+ <para>
+ File operations for the DRM device node.
+ </para>
+ </abstract>
<para>
Drivers must define the file operations structure that forms the DRM
userspace API entry point, even though most of those operations are
@@ -3717,14 +3724,17 @@ void (*postclose) (struct drm_device *, struct drm_file *);</synopsis>
<title>IOCTLs</title>
<synopsis>struct drm_ioctl_desc *ioctls;
int num_ioctls;</synopsis>
- <abstract>Driver-specific ioctls descriptors table.</abstract>
+ <abstract>
+ <para>
+ Driver-specific ioctls descriptors table.
+ </para>
+ </abstract>
<para>
Driver-specific ioctls numbers start at DRM_COMMAND_BASE. The ioctls
descriptors table is indexed by the ioctl number offset from the base
value. Drivers can use the DRM_IOCTL_DEF_DRV() macro to initialize the
table entries.
</para>
- <para>
<programlisting>DRM_IOCTL_DEF_DRV(ioctl, func, flags)</programlisting>
<para>
<parameter>ioctl</parameter> is the ioctl name. Drivers must define
@@ -3763,7 +3773,6 @@ int num_ioctls;</synopsis>
</para></listitem>
</itemizedlist>
</para>
- </para>
</sect2>
</sect1>
<sect1>
--
2.4.3
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/intel-gfx
next prev parent reply other threads:[~2015-08-25 9:26 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-25 9:26 [PATCH 0/5] Documentation: drm: Make drm.tmpl build as pdfdoc Graham Whaley
2015-08-25 9:26 ` [PATCH 1/5] Documentation: drm: Fix pdfdocs sect/title tags Graham Whaley
2015-08-25 11:34 ` Daniel Vetter
2015-08-25 14:42 ` Graham Whaley
2015-08-25 9:26 ` Graham Whaley [this message]
2015-08-25 9:26 ` [PATCH 3/5] Documentation: drm: Change <code> to <literal> Graham Whaley
2015-08-25 9:26 ` [PATCH 4/5] Documentation: drm: Convert KMS Properties HTML table to CALS Graham Whaley
2015-08-25 14:29 ` Daniel Vetter
2015-08-25 16:10 ` Graham Whaley
2015-08-26 9:32 ` [Intel-gfx] " Daniel Vetter
2015-09-01 17:56 ` Danilo Cesar Lemes de Paula
2015-09-02 9:22 ` Graham Whaley
2015-09-02 13:50 ` Graham Whaley
2015-08-25 9:26 ` [PATCH 5/5] Documentation: drm: Unify quoting methods Graham Whaley
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=1440494805-13325-3-git-send-email-graham.whaley@linux.intel.com \
--to=graham.whaley@linux.intel.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@intel.com \
--cc=danilo.cesar@collabora.co.uk \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox