Skip to content

L
linux
Commit f03d8ede authored by Danilo Cesar Lemes de Paula's avatar Danilo Cesar Lemes de Paula Committed by Daniel Vetter
Browse files
Options

drm/doc: Convert to markdown 

DRM Docbook is now Markdown ready. This means its doc is able to
use markdown text on it.

* Documentation/DocBook/drm.tmpl: Contains a table duplicated from
  drivers/gpu/drm/i915/i915_reg.h. This is not needed anymore

* drivers/gpu/drm/drm_modeset_lock.c: had a code example that used
  to look pretty bad on html. Fixed by using proper code markup.

* drivers/gpu/drm/drm_prime.c: Remove spaces between lines to make
  a proper markup list.

* drivers/gpu/drm/i915/i915_reg.h: Altought pandoc supports tables,
  it doesn't support table cell spanning. But we can use fixed-width
  for those special cases.

* include/drm/drm_vma_manager.h: Another code example that should be
  proper indented with four spaces.

v2 (Daniel): Adjust name to gpu.xml due to rename.

v3 (Daniel):
Split out the actual enabling in the Makefile - this way we can merge
the conversion, while just keeping the enabling in a drm-private tree.

Signed-off-by: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> (v1)
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Stephan Mueller <smueller@chronox.de>
Cc: Michal Marek <mmarek@suse.cz>
Cc: linux-kernel@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Cc: intel-gfx <intel-gfx@lists.freedesktop.org>
Cc: dri-devel <dri-devel@lists.freedesktop.org>
Acked-by: default avatarDave Airlie <airlied@redhat.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1448471279-19748-2-git-send-email-daniel.vetter@ffwll.ch
parent 51bce5bc
Show whitespace changes
Inline Side-by-side
Showing with 42 additions and 134 deletions
Documentation/DocBook/gpu.tmpl
View file @ f03d8ede
...@@ -3570,92 +3570,6 @@ int num_ioctls;</synopsis> ...@@ -3570,92 +3570,6 @@ int num_ioctls;</synopsis>
<sect2> <sect2>
<title>DPIO</title> <title>DPIO</title>
!Pdrivers/gpu/drm/i915/i915_reg.h DPIO !Pdrivers/gpu/drm/i915/i915_reg.h DPIO
<table id="dpiox2">
<title>Dual channel PHY (VLV/CHV/BXT)</title>
<tgroup cols="8">
<colspec colname="c0" />
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<colspec colname="c4" />
<colspec colname="c5" />
<colspec colname="c6" />
<colspec colname="c7" />
<spanspec spanname="ch0" namest="c0" nameend="c3" />
<spanspec spanname="ch1" namest="c4" nameend="c7" />
<spanspec spanname="ch0pcs01" namest="c0" nameend="c1" />
<spanspec spanname="ch0pcs23" namest="c2" nameend="c3" />
<spanspec spanname="ch1pcs01" namest="c4" nameend="c5" />
<spanspec spanname="ch1pcs23" namest="c6" nameend="c7" />
<thead>
<row>
<entry spanname="ch0">CH0</entry>
<entry spanname="ch1">CH1</entry>
</row>
</thead>
<tbody valign="top" align="center">
<row>
<entry spanname="ch0">CMN/PLL/REF</entry>
<entry spanname="ch1">CMN/PLL/REF</entry>
</row>
<row>
<entry spanname="ch0pcs01">PCS01</entry>
<entry spanname="ch0pcs23">PCS23</entry>
<entry spanname="ch1pcs01">PCS01</entry>
<entry spanname="ch1pcs23">PCS23</entry>
</row>
<row>
<entry>TX0</entry>
<entry>TX1</entry>
<entry>TX2</entry>
<entry>TX3</entry>
<entry>TX0</entry>
<entry>TX1</entry>
<entry>TX2</entry>
<entry>TX3</entry>
</row>
<row>
<entry spanname="ch0">DDI0</entry>
<entry spanname="ch1">DDI1</entry>
</row>
</tbody>
</tgroup>
</table>
<table id="dpiox1">
<title>Single channel PHY (CHV/BXT)</title>
<tgroup cols="4">
<colspec colname="c0" />
<colspec colname="c1" />
<colspec colname="c2" />
<colspec colname="c3" />
<spanspec spanname="ch0" namest="c0" nameend="c3" />
<spanspec spanname="ch0pcs01" namest="c0" nameend="c1" />
<spanspec spanname="ch0pcs23" namest="c2" nameend="c3" />
<thead>
<row>
<entry spanname="ch0">CH0</entry>
</row>
</thead>
<tbody valign="top" align="center">
<row>
<entry spanname="ch0">CMN/PLL/REF</entry>
</row>
<row>
<entry spanname="ch0pcs01">PCS01</entry>
<entry spanname="ch0pcs23">PCS23</entry>
</row>
<row>
<entry>TX0</entry>
<entry>TX1</entry>
<entry>TX2</entry>
<entry>TX3</entry>
</row>
<row>
<entry spanname="ch0">DDI2</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2> </sect2>
<sect2> <sect2>
......
drivers/gpu/drm/drm_modeset_lock.c
View file @ f03d8ede
...@@ -48,9 +48,7 @@ ...@@ -48,9 +48,7 @@
* goto retry; * goto retry;
* } * }
* } * }
*
* ... do stuff ... * ... do stuff ...
*
* drm_modeset_drop_locks(&ctx); * drm_modeset_drop_locks(&ctx);
* drm_modeset_acquire_fini(&ctx); * drm_modeset_acquire_fini(&ctx);
*/ */
......
drivers/gpu/drm/drm_prime.c
View file @ f03d8ede
...@@ -313,19 +313,15 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = { ...@@ -313,19 +313,15 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {
* *
* Export callbacks: * Export callbacks:
* *
* - @gem_prime_pin (optional): prepare a GEM object for exporting * * @gem_prime_pin (optional): prepare a GEM object for exporting
* * * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
* - @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages * * @gem_prime_vmap: vmap a buffer exported by your driver
* * * @gem_prime_vunmap: vunmap a buffer exported by your driver
* - @gem_prime_vmap: vmap a buffer exported by your driver * * @gem_prime_mmap (optional): mmap a buffer exported by your driver
*
* - @gem_prime_vunmap: vunmap a buffer exported by your driver
*
* - @gem_prime_mmap (optional): mmap a buffer exported by your driver
* *
* Import callback: * Import callback:
* *
* - @gem_prime_import_sg_table (import): produce a GEM object from another * * @gem_prime_import_sg_table (import): produce a GEM object from another
* driver's scatter/gather table * driver's scatter/gather table
*/ */
......
drivers/gpu/drm/i915/i915_reg.h
View file @ f03d8ede
...@@ -855,8 +855,8 @@ enum skl_disp_power_wells { ...@@ -855,8 +855,8 @@ enum skl_disp_power_wells {
* *
* Note: DDI0 is digital port B, DD1 is digital port C, and DDI2 is * Note: DDI0 is digital port B, DD1 is digital port C, and DDI2 is
* digital port D (CHV) or port A (BXT). * digital port D (CHV) or port A (BXT).
*/ *
/* *
* Dual channel PHY (VLV/CHV/BXT) * Dual channel PHY (VLV/CHV/BXT)
* --------------------------------- * ---------------------------------
* | CH0 | CH1 | * | CH0 | CH1 |
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7