All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
       [not found] <890e1aabffc12303f8c110aa5686ad51b01eed6b>
@ 2016-06-01 14:44 ` Daniel Vetter
  2016-06-06  7:10   ` Jani Nikula
  0 siblings, 1 reply; 8+ messages in thread
From: Daniel Vetter @ 2016-06-01 14:44 UTC (permalink / raw)
  To: DRI Development; +Cc: Daniel Vetter, Daniel Vetter

Just fallout from switching from asciidoc to sphinx/rst.

v2: Found more. Also s/\//#/ in the vgpu ascii-art - sphinx treats
those as comments and switch to variable-width, which wreaks the
layout.

v3: Undo some of the hacks, rebasing onto latest version of Jani's
series fixed it.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 drivers/gpu/drm/drm_bridge.c        |  2 +-
 drivers/gpu/drm/drm_fb_cma_helper.c |  2 +-
 drivers/gpu/drm/drm_fops.c          |  2 +-
 drivers/gpu/drm/drm_modes.c         |  3 ++-
 drivers/gpu/drm/drm_modeset_lock.c  |  2 +-
 drivers/gpu/drm/drm_vma_manager.c   |  3 +++
 drivers/gpu/drm/i915/i915_reg.h     |  2 +-
 drivers/gpu/drm/i915/i915_vgpu.c    | 24 ++++++++++++------------
 include/drm/drm_modes.h             |  2 ++
 9 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index b3654404abd0..255543086590 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -36,7 +36,7 @@
  * encoder chain.
  *
  * A bridge is always attached to a single &drm_encoder at a time, but can be
- * either connected to it directly, or through an intermediate bridge:
+ * either connected to it directly, or through an intermediate bridge::
  *
  *     encoder ---> bridge B ---> bridge A
  *
diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c
index 2b33b191a172..c50a0ba6fdba 100644
--- a/drivers/gpu/drm/drm_fb_cma_helper.c
+++ b/drivers/gpu/drm/drm_fb_cma_helper.c
@@ -52,7 +52,7 @@ struct drm_fbdev_cma {
  * will be set up automatically. dirty() is called by
  * drm_fb_helper_deferred_io() in process context (struct delayed_work).
  *
- * Example fbdev deferred io code:
+ * Example fbdev deferred io code::
  *
  *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
  *                                      struct drm_file *file_priv,
diff --git a/drivers/gpu/drm/drm_fops.c b/drivers/gpu/drm/drm_fops.c
index 5921b203503a..323c238fcac7 100644
--- a/drivers/gpu/drm/drm_fops.c
+++ b/drivers/gpu/drm/drm_fops.c
@@ -68,7 +68,7 @@ DEFINE_MUTEX(drm_global_mutex);
  * specific implementations. For GEM-based drivers this is drm_gem_mmap().
  *
  * No other file operations are supported by the DRM userspace API. Overall the
- * following is an example #file_operations structure:
+ * following is an example #file_operations structure::
  *
  *     static const example_drm_fops = {
  *             .owner = THIS_MODULE,
diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index e5e6f504d8cc..1eb679e5fbb1 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -552,7 +552,8 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
  * I also refer to the function of fb_get_mode in the file of
  * drivers/video/fbmon.c
  *
- * Standard GTF parameters:
+ * Standard GTF parameters::
+ *
  *     M = 600
  *     C = 40
  *     K = 128
diff --git a/drivers/gpu/drm/drm_modeset_lock.c b/drivers/gpu/drm/drm_modeset_lock.c
index f33ebe638a28..61146f5b4f56 100644
--- a/drivers/gpu/drm/drm_modeset_lock.c
+++ b/drivers/gpu/drm/drm_modeset_lock.c
@@ -37,7 +37,7 @@
  *
  * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
  *
- * The basic usage pattern is to:
+ * The basic usage pattern is to::
  *
  *     drm_modeset_acquire_init(&ctx)
  *     retry:
diff --git a/drivers/gpu/drm/drm_vma_manager.c b/drivers/gpu/drm/drm_vma_manager.c
index 2f2ecde8285b..f306c8855978 100644
--- a/drivers/gpu/drm/drm_vma_manager.c
+++ b/drivers/gpu/drm/drm_vma_manager.c
@@ -127,6 +127,9 @@ EXPORT_SYMBOL(drm_vma_offset_manager_destroy);
  * used to implement weakly referenced lookups using kref_get_unless_zero().
  *
  * Example:
+ *
+ * ::
+ *
  *     drm_vma_offset_lock_lookup(mgr);
  *     node = drm_vma_offset_lookup_locked(mgr);
  *     if (node)
diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
index 216cc4ba74ee..d25dd1d694bc 100644
--- a/drivers/gpu/drm/i915/i915_reg.h
+++ b/drivers/gpu/drm/i915/i915_reg.h
@@ -886,7 +886,7 @@ enum skl_disp_power_wells {
  * PLLs can be routed to any transcoder A/B/C.
  *
  * 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)
diff --git a/drivers/gpu/drm/i915/i915_vgpu.c b/drivers/gpu/drm/i915/i915_vgpu.c
index d5a7a5e7ee7e..004326291854 100644
--- a/drivers/gpu/drm/i915/i915_vgpu.c
+++ b/drivers/gpu/drm/i915/i915_vgpu.c
@@ -150,28 +150,28 @@ static int vgt_balloon_space(struct drm_mm *mm,
  * of its graphic space being zero. Yet there are some portions ballooned out(
  * the shadow part, which are marked as reserved by drm allocator). From the
  * host point of view, the graphic address space is partitioned by multiple
- * vGPUs in different VMs.
+ * vGPUs in different VMs. ::
  *
  *                        vGPU1 view         Host view
  *             0 ------> +-----------+     +-----------+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *        mappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               v       |///////////|     |   Host    |
+ *               |       |###########|     |           |
+ *               v       |###########|     |   Host    |
  *               +=======+===========+     +===========+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *      unmappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               |       |///////////|     |   Host    |
- *               v       |///////////|     |           |
+ *               |       |###########|     |           |
+ *               |       |###########|     |   Host    |
+ *               v       |###########|     |           |
  * total GM size ------> +-----------+     +-----------+
  *
  * Returns:
diff --git a/include/drm/drm_modes.h b/include/drm/drm_modes.h
index 625966a906f2..ff481770d76b 100644
--- a/include/drm/drm_modes.h
+++ b/include/drm/drm_modes.h
@@ -169,6 +169,8 @@ enum drm_mode_status {
  *
  * The horizontal and vertical timings are defined per the following diagram.
  *
+ * ::
+ *
  *
  *               Active                 Front           Sync           Back
  *              Region                 Porch                          Porch
-- 
2.8.1

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

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01 14:44 ` [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting Daniel Vetter
@ 2016-06-06  7:10   ` Jani Nikula
  0 siblings, 0 replies; 8+ messages in thread
From: Jani Nikula @ 2016-06-06  7:10 UTC (permalink / raw)
  To: DRI Development; +Cc: Daniel Vetter, Daniel Vetter

On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> Just fallout from switching from asciidoc to sphinx/rst.
>
> v2: Found more. Also s/\//#/ in the vgpu ascii-art - sphinx treats
> those as comments and switch to variable-width, which wreaks the
> layout.
>
> v3: Undo some of the hacks, rebasing onto latest version of Jani's
> series fixed it.
>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>

I'll take your word for it that Sphinx no longer complains and the
result looks good.

Reviewed-by: Jani Nikula <jani.nikula@intel.com>


> ---
>  drivers/gpu/drm/drm_bridge.c        |  2 +-
>  drivers/gpu/drm/drm_fb_cma_helper.c |  2 +-
>  drivers/gpu/drm/drm_fops.c          |  2 +-
>  drivers/gpu/drm/drm_modes.c         |  3 ++-
>  drivers/gpu/drm/drm_modeset_lock.c  |  2 +-
>  drivers/gpu/drm/drm_vma_manager.c   |  3 +++
>  drivers/gpu/drm/i915/i915_reg.h     |  2 +-
>  drivers/gpu/drm/i915/i915_vgpu.c    | 24 ++++++++++++------------
>  include/drm/drm_modes.h             |  2 ++
>  9 files changed, 24 insertions(+), 18 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> index b3654404abd0..255543086590 100644
> --- a/drivers/gpu/drm/drm_bridge.c
> +++ b/drivers/gpu/drm/drm_bridge.c
> @@ -36,7 +36,7 @@
>   * encoder chain.
>   *
>   * A bridge is always attached to a single &drm_encoder at a time, but can be
> - * either connected to it directly, or through an intermediate bridge:
> + * either connected to it directly, or through an intermediate bridge::
>   *
>   *     encoder ---> bridge B ---> bridge A
>   *
> diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c
> index 2b33b191a172..c50a0ba6fdba 100644
> --- a/drivers/gpu/drm/drm_fb_cma_helper.c
> +++ b/drivers/gpu/drm/drm_fb_cma_helper.c
> @@ -52,7 +52,7 @@ struct drm_fbdev_cma {
>   * will be set up automatically. dirty() is called by
>   * drm_fb_helper_deferred_io() in process context (struct delayed_work).
>   *
> - * Example fbdev deferred io code:
> + * Example fbdev deferred io code::
>   *
>   *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
>   *                                      struct drm_file *file_priv,
> diff --git a/drivers/gpu/drm/drm_fops.c b/drivers/gpu/drm/drm_fops.c
> index 5921b203503a..323c238fcac7 100644
> --- a/drivers/gpu/drm/drm_fops.c
> +++ b/drivers/gpu/drm/drm_fops.c
> @@ -68,7 +68,7 @@ DEFINE_MUTEX(drm_global_mutex);
>   * specific implementations. For GEM-based drivers this is drm_gem_mmap().
>   *
>   * No other file operations are supported by the DRM userspace API. Overall the
> - * following is an example #file_operations structure:
> + * following is an example #file_operations structure::
>   *
>   *     static const example_drm_fops = {
>   *             .owner = THIS_MODULE,
> diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
> index e5e6f504d8cc..1eb679e5fbb1 100644
> --- a/drivers/gpu/drm/drm_modes.c
> +++ b/drivers/gpu/drm/drm_modes.c
> @@ -552,7 +552,8 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
>   * I also refer to the function of fb_get_mode in the file of
>   * drivers/video/fbmon.c
>   *
> - * Standard GTF parameters:
> + * Standard GTF parameters::
> + *
>   *     M = 600
>   *     C = 40
>   *     K = 128
> diff --git a/drivers/gpu/drm/drm_modeset_lock.c b/drivers/gpu/drm/drm_modeset_lock.c
> index f33ebe638a28..61146f5b4f56 100644
> --- a/drivers/gpu/drm/drm_modeset_lock.c
> +++ b/drivers/gpu/drm/drm_modeset_lock.c
> @@ -37,7 +37,7 @@
>   *
>   * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
>   *
> - * The basic usage pattern is to:
> + * The basic usage pattern is to::
>   *
>   *     drm_modeset_acquire_init(&ctx)
>   *     retry:
> diff --git a/drivers/gpu/drm/drm_vma_manager.c b/drivers/gpu/drm/drm_vma_manager.c
> index 2f2ecde8285b..f306c8855978 100644
> --- a/drivers/gpu/drm/drm_vma_manager.c
> +++ b/drivers/gpu/drm/drm_vma_manager.c
> @@ -127,6 +127,9 @@ EXPORT_SYMBOL(drm_vma_offset_manager_destroy);
>   * used to implement weakly referenced lookups using kref_get_unless_zero().
>   *
>   * Example:
> + *
> + * ::
> + *
>   *     drm_vma_offset_lock_lookup(mgr);
>   *     node = drm_vma_offset_lookup_locked(mgr);
>   *     if (node)
> diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
> index 216cc4ba74ee..d25dd1d694bc 100644
> --- a/drivers/gpu/drm/i915/i915_reg.h
> +++ b/drivers/gpu/drm/i915/i915_reg.h
> @@ -886,7 +886,7 @@ enum skl_disp_power_wells {
>   * PLLs can be routed to any transcoder A/B/C.
>   *
>   * 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)
> diff --git a/drivers/gpu/drm/i915/i915_vgpu.c b/drivers/gpu/drm/i915/i915_vgpu.c
> index d5a7a5e7ee7e..004326291854 100644
> --- a/drivers/gpu/drm/i915/i915_vgpu.c
> +++ b/drivers/gpu/drm/i915/i915_vgpu.c
> @@ -150,28 +150,28 @@ static int vgt_balloon_space(struct drm_mm *mm,
>   * of its graphic space being zero. Yet there are some portions ballooned out(
>   * the shadow part, which are marked as reserved by drm allocator). From the
>   * host point of view, the graphic address space is partitioned by multiple
> - * vGPUs in different VMs.
> + * vGPUs in different VMs. ::
>   *
>   *                        vGPU1 view         Host view
>   *             0 ------> +-----------+     +-----------+
> - *               ^       |///////////|     |   vGPU3   |
> - *               |       |///////////|     +-----------+
> - *               |       |///////////|     |   vGPU2   |
> + *               ^       |###########|     |   vGPU3   |
> + *               |       |###########|     +-----------+
> + *               |       |###########|     |   vGPU2   |
>   *               |       +-----------+     +-----------+
>   *        mappable GM    | available | ==> |   vGPU1   |
>   *               |       +-----------+     +-----------+
> - *               |       |///////////|     |           |
> - *               v       |///////////|     |   Host    |
> + *               |       |###########|     |           |
> + *               v       |###########|     |   Host    |
>   *               +=======+===========+     +===========+
> - *               ^       |///////////|     |   vGPU3   |
> - *               |       |///////////|     +-----------+
> - *               |       |///////////|     |   vGPU2   |
> + *               ^       |###########|     |   vGPU3   |
> + *               |       |###########|     +-----------+
> + *               |       |###########|     |   vGPU2   |
>   *               |       +-----------+     +-----------+
>   *      unmappable GM    | available | ==> |   vGPU1   |
>   *               |       +-----------+     +-----------+
> - *               |       |///////////|     |           |
> - *               |       |///////////|     |   Host    |
> - *               v       |///////////|     |           |
> + *               |       |###########|     |           |
> + *               |       |###########|     |   Host    |
> + *               v       |###########|     |           |
>   * total GM size ------> +-----------+     +-----------+
>   *
>   * Returns:
> diff --git a/include/drm/drm_modes.h b/include/drm/drm_modes.h
> index 625966a906f2..ff481770d76b 100644
> --- a/include/drm/drm_modes.h
> +++ b/include/drm/drm_modes.h
> @@ -169,6 +169,8 @@ enum drm_mode_status {
>   *
>   * The horizontal and vertical timings are defined per the following diagram.
>   *
> + * ::
> + *
>   *
>   *               Active                 Front           Sync           Back
>   *              Region                 Porch                          Porch

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01  8:46 ` [PATCH] " Daniel Vetter
  2016-06-01  9:46   ` Jani Nikula
@ 2016-06-02 14:29   ` Daniel Vetter
  1 sibling, 0 replies; 8+ messages in thread
From: Daniel Vetter @ 2016-06-02 14:29 UTC (permalink / raw)
  To: DRI Development; +Cc: Daniel Vetter, Daniel Vetter

Just fallout from switching from asciidoc to sphinx/rst.

v2: Found more. Also s/\//#/ in the vgpu ascii-art - sphinx treats
those as comments and switch to variable-width, which wreaks the
layout.

v3: Undo some of the hacks, rebasing onto latest version of Jani's
series fixed it.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 drivers/gpu/drm/drm_bridge.c        |  2 +-
 drivers/gpu/drm/drm_fb_cma_helper.c |  2 +-
 drivers/gpu/drm/drm_fops.c          |  2 +-
 drivers/gpu/drm/drm_modes.c         |  3 ++-
 drivers/gpu/drm/drm_modeset_lock.c  |  2 +-
 drivers/gpu/drm/drm_vma_manager.c   |  3 +++
 drivers/gpu/drm/i915/i915_reg.h     |  2 +-
 drivers/gpu/drm/i915/i915_vgpu.c    | 24 ++++++++++++------------
 include/drm/drm_modes.h             |  2 ++
 9 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index b3654404abd0..255543086590 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -36,7 +36,7 @@
  * encoder chain.
  *
  * A bridge is always attached to a single &drm_encoder at a time, but can be
- * either connected to it directly, or through an intermediate bridge:
+ * either connected to it directly, or through an intermediate bridge::
  *
  *     encoder ---> bridge B ---> bridge A
  *
diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c
index 2b33b191a172..c50a0ba6fdba 100644
--- a/drivers/gpu/drm/drm_fb_cma_helper.c
+++ b/drivers/gpu/drm/drm_fb_cma_helper.c
@@ -52,7 +52,7 @@ struct drm_fbdev_cma {
  * will be set up automatically. dirty() is called by
  * drm_fb_helper_deferred_io() in process context (struct delayed_work).
  *
- * Example fbdev deferred io code:
+ * Example fbdev deferred io code::
  *
  *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
  *                                      struct drm_file *file_priv,
diff --git a/drivers/gpu/drm/drm_fops.c b/drivers/gpu/drm/drm_fops.c
index 5921b203503a..323c238fcac7 100644
--- a/drivers/gpu/drm/drm_fops.c
+++ b/drivers/gpu/drm/drm_fops.c
@@ -68,7 +68,7 @@ DEFINE_MUTEX(drm_global_mutex);
  * specific implementations. For GEM-based drivers this is drm_gem_mmap().
  *
  * No other file operations are supported by the DRM userspace API. Overall the
- * following is an example #file_operations structure:
+ * following is an example #file_operations structure::
  *
  *     static const example_drm_fops = {
  *             .owner = THIS_MODULE,
diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index e5e6f504d8cc..1eb679e5fbb1 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -552,7 +552,8 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
  * I also refer to the function of fb_get_mode in the file of
  * drivers/video/fbmon.c
  *
- * Standard GTF parameters:
+ * Standard GTF parameters::
+ *
  *     M = 600
  *     C = 40
  *     K = 128
diff --git a/drivers/gpu/drm/drm_modeset_lock.c b/drivers/gpu/drm/drm_modeset_lock.c
index f33ebe638a28..61146f5b4f56 100644
--- a/drivers/gpu/drm/drm_modeset_lock.c
+++ b/drivers/gpu/drm/drm_modeset_lock.c
@@ -37,7 +37,7 @@
  *
  * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
  *
- * The basic usage pattern is to:
+ * The basic usage pattern is to::
  *
  *     drm_modeset_acquire_init(&ctx)
  *     retry:
diff --git a/drivers/gpu/drm/drm_vma_manager.c b/drivers/gpu/drm/drm_vma_manager.c
index 2f2ecde8285b..f306c8855978 100644
--- a/drivers/gpu/drm/drm_vma_manager.c
+++ b/drivers/gpu/drm/drm_vma_manager.c
@@ -127,6 +127,9 @@ EXPORT_SYMBOL(drm_vma_offset_manager_destroy);
  * used to implement weakly referenced lookups using kref_get_unless_zero().
  *
  * Example:
+ *
+ * ::
+ *
  *     drm_vma_offset_lock_lookup(mgr);
  *     node = drm_vma_offset_lookup_locked(mgr);
  *     if (node)
diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
index 216cc4ba74ee..d25dd1d694bc 100644
--- a/drivers/gpu/drm/i915/i915_reg.h
+++ b/drivers/gpu/drm/i915/i915_reg.h
@@ -886,7 +886,7 @@ enum skl_disp_power_wells {
  * PLLs can be routed to any transcoder A/B/C.
  *
  * 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)
diff --git a/drivers/gpu/drm/i915/i915_vgpu.c b/drivers/gpu/drm/i915/i915_vgpu.c
index d5a7a5e7ee7e..004326291854 100644
--- a/drivers/gpu/drm/i915/i915_vgpu.c
+++ b/drivers/gpu/drm/i915/i915_vgpu.c
@@ -150,28 +150,28 @@ static int vgt_balloon_space(struct drm_mm *mm,
  * of its graphic space being zero. Yet there are some portions ballooned out(
  * the shadow part, which are marked as reserved by drm allocator). From the
  * host point of view, the graphic address space is partitioned by multiple
- * vGPUs in different VMs.
+ * vGPUs in different VMs. ::
  *
  *                        vGPU1 view         Host view
  *             0 ------> +-----------+     +-----------+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *        mappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               v       |///////////|     |   Host    |
+ *               |       |###########|     |           |
+ *               v       |###########|     |   Host    |
  *               +=======+===========+     +===========+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *      unmappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               |       |///////////|     |   Host    |
- *               v       |///////////|     |           |
+ *               |       |###########|     |           |
+ *               |       |###########|     |   Host    |
+ *               v       |###########|     |           |
  * total GM size ------> +-----------+     +-----------+
  *
  * Returns:
diff --git a/include/drm/drm_modes.h b/include/drm/drm_modes.h
index 625966a906f2..ff481770d76b 100644
--- a/include/drm/drm_modes.h
+++ b/include/drm/drm_modes.h
@@ -169,6 +169,8 @@ enum drm_mode_status {
  *
  * The horizontal and vertical timings are defined per the following diagram.
  *
+ * ::
+ *
  *
  *               Active                 Front           Sync           Back
  *              Region                 Porch                          Porch
-- 
2.8.1

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

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01 13:46       ` Jani Nikula
@ 2016-06-01 14:44         ` Daniel Vetter
  0 siblings, 0 replies; 8+ messages in thread
From: Daniel Vetter @ 2016-06-01 14:44 UTC (permalink / raw)
  To: Jani Nikula; +Cc: Daniel Vetter, DRI Development, Daniel Vetter

On Wed, Jun 01, 2016 at 04:46:10PM +0300, Jani Nikula wrote:
> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> > On Wed, Jun 1, 2016 at 11:46 AM, Jani Nikula
> > <jani.nikula@linux.intel.com> wrote:
> >> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> >>> There's still something very fishy going on with some of these, e.g.
> >>> the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
> >>> somehow get treated as heading when just appending a :: at the end of
> >>> those lines. But it seems to work everywhere else. Maybe the
> >>> kernel-doc heading generation logic is still a bit wonky?
> >>
> >> Try adding a blank line between the line with trailing :: and the actual
> >> preformatted text. Seems to do the right thing for me.
> >>
> >> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
> >>
> >> "Blank lines are required before and after a literal block, but these
> >> blank lines are not included as part of the literal block."
> >
> > That's not what I've meant. The following sometimes (but not always,
> > only in the 2 places I've mentioned) becomes a kernel-doc directive
> 
> What do you mean by "kernel-doc directive" exactly?
> 
> > and not a block quote:
> >
> >  * Standard GTF Parameters::
> >  *
> >  *     stuff I wanted to have block quoted.
> >
> > But if I switch the :: to be on a line of it's own (like in the patch)
> > it's totally fine.
> 
> Odd. It does seem to work for me. What does this print near there?
> 
> $ scripts/kernel-doc -rst -function drm_gtf_mode drivers/gpu/drm/drm_modes.c

Tried again, it works now. Probably fixed through some rebasing and me
being on an older version of your toolchain. I'll send out v3.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01 13:33     ` Daniel Vetter
@ 2016-06-01 13:46       ` Jani Nikula
  2016-06-01 14:44         ` Daniel Vetter
  0 siblings, 1 reply; 8+ messages in thread
From: Jani Nikula @ 2016-06-01 13:46 UTC (permalink / raw)
  To: Daniel Vetter; +Cc: Daniel Vetter, DRI Development

On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> On Wed, Jun 1, 2016 at 11:46 AM, Jani Nikula
> <jani.nikula@linux.intel.com> wrote:
>> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>>> There's still something very fishy going on with some of these, e.g.
>>> the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
>>> somehow get treated as heading when just appending a :: at the end of
>>> those lines. But it seems to work everywhere else. Maybe the
>>> kernel-doc heading generation logic is still a bit wonky?
>>
>> Try adding a blank line between the line with trailing :: and the actual
>> preformatted text. Seems to do the right thing for me.
>>
>> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
>>
>> "Blank lines are required before and after a literal block, but these
>> blank lines are not included as part of the literal block."
>
> That's not what I've meant. The following sometimes (but not always,
> only in the 2 places I've mentioned) becomes a kernel-doc directive

What do you mean by "kernel-doc directive" exactly?

> and not a block quote:
>
>  * Standard GTF Parameters::
>  *
>  *     stuff I wanted to have block quoted.
>
> But if I switch the :: to be on a line of it's own (like in the patch)
> it's totally fine.

Odd. It does seem to work for me. What does this print near there?

$ scripts/kernel-doc -rst -function drm_gtf_mode drivers/gpu/drm/drm_modes.c



BR,
Jani.



-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01  9:46   ` Jani Nikula
@ 2016-06-01 13:33     ` Daniel Vetter
  2016-06-01 13:46       ` Jani Nikula
  0 siblings, 1 reply; 8+ messages in thread
From: Daniel Vetter @ 2016-06-01 13:33 UTC (permalink / raw)
  To: Jani Nikula; +Cc: Daniel Vetter, DRI Development

On Wed, Jun 1, 2016 at 11:46 AM, Jani Nikula
<jani.nikula@linux.intel.com> wrote:
> On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
>> There's still something very fishy going on with some of these, e.g.
>> the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
>> somehow get treated as heading when just appending a :: at the end of
>> those lines. But it seems to work everywhere else. Maybe the
>> kernel-doc heading generation logic is still a bit wonky?
>
> Try adding a blank line between the line with trailing :: and the actual
> preformatted text. Seems to do the right thing for me.
>
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks
>
> "Blank lines are required before and after a literal block, but these
> blank lines are not included as part of the literal block."

That's not what I've meant. The following sometimes (but not always,
only in the 2 places I've mentioned) becomes a kernel-doc directive
and not a block quote:

 * Standard GTF Parameters::
 *
 *     stuff I wanted to have block quoted.

But if I switch the :: to be on a line of it's own (like in the patch)
it's totally fine.
-Daniel
-- 
Daniel Vetter
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-06-01  8:46 ` [PATCH] " Daniel Vetter
@ 2016-06-01  9:46   ` Jani Nikula
  2016-06-01 13:33     ` Daniel Vetter
  2016-06-02 14:29   ` Daniel Vetter
  1 sibling, 1 reply; 8+ messages in thread
From: Jani Nikula @ 2016-06-01  9:46 UTC (permalink / raw)
  To: DRI Development; +Cc: Daniel Vetter, Daniel Vetter

On Wed, 01 Jun 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote:
> There's still something very fishy going on with some of these, e.g.
> the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
> somehow get treated as heading when just appending a :: at the end of
> those lines. But it seems to work everywhere else. Maybe the
> kernel-doc heading generation logic is still a bit wonky?

Try adding a blank line between the line with trailing :: and the actual
preformatted text. Seems to do the right thing for me.

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks

"Blank lines are required before and after a literal block, but these
blank lines are not included as part of the literal block."


BR,
Jani.

> v2: Found more. Also s/\//#/ in the vgpu ascii-art - sphinx treats
> those as comments and switch to variable-width, which wreaks the
> layout.
>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
>  drivers/gpu/drm/drm_bridge.c        |  2 +-
>  drivers/gpu/drm/drm_fb_cma_helper.c |  2 +-
>  drivers/gpu/drm/drm_fops.c          |  2 +-
>  drivers/gpu/drm/drm_modes.c         |  5 ++++-
>  drivers/gpu/drm/drm_modeset_lock.c  |  2 +-
>  drivers/gpu/drm/drm_vma_manager.c   |  3 +++
>  drivers/gpu/drm/i915/i915_reg.h     |  2 +-
>  drivers/gpu/drm/i915/i915_vgpu.c    | 24 ++++++++++++------------
>  include/drm/drm_modes.h             |  2 ++
>  9 files changed, 26 insertions(+), 18 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> index b3654404abd0..255543086590 100644
> --- a/drivers/gpu/drm/drm_bridge.c
> +++ b/drivers/gpu/drm/drm_bridge.c
> @@ -36,7 +36,7 @@
>   * encoder chain.
>   *
>   * A bridge is always attached to a single &drm_encoder at a time, but can be
> - * either connected to it directly, or through an intermediate bridge:
> + * either connected to it directly, or through an intermediate bridge::
>   *
>   *     encoder ---> bridge B ---> bridge A
>   *
> diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c
> index 2b33b191a172..c50a0ba6fdba 100644
> --- a/drivers/gpu/drm/drm_fb_cma_helper.c
> +++ b/drivers/gpu/drm/drm_fb_cma_helper.c
> @@ -52,7 +52,7 @@ struct drm_fbdev_cma {
>   * will be set up automatically. dirty() is called by
>   * drm_fb_helper_deferred_io() in process context (struct delayed_work).
>   *
> - * Example fbdev deferred io code:
> + * Example fbdev deferred io code::
>   *
>   *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
>   *                                      struct drm_file *file_priv,
> diff --git a/drivers/gpu/drm/drm_fops.c b/drivers/gpu/drm/drm_fops.c
> index 5921b203503a..323c238fcac7 100644
> --- a/drivers/gpu/drm/drm_fops.c
> +++ b/drivers/gpu/drm/drm_fops.c
> @@ -68,7 +68,7 @@ DEFINE_MUTEX(drm_global_mutex);
>   * specific implementations. For GEM-based drivers this is drm_gem_mmap().
>   *
>   * No other file operations are supported by the DRM userspace API. Overall the
> - * following is an example #file_operations structure:
> + * following is an example #file_operations structure::
>   *
>   *     static const example_drm_fops = {
>   *             .owner = THIS_MODULE,
> diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
> index e5e6f504d8cc..aae86c1857ec 100644
> --- a/drivers/gpu/drm/drm_modes.c
> +++ b/drivers/gpu/drm/drm_modes.c
> @@ -552,7 +552,10 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
>   * I also refer to the function of fb_get_mode in the file of
>   * drivers/video/fbmon.c
>   *
> - * Standard GTF parameters:
> + * Standard GTF parameters
> + *
> + * ::
> + *
>   *     M = 600
>   *     C = 40
>   *     K = 128
> diff --git a/drivers/gpu/drm/drm_modeset_lock.c b/drivers/gpu/drm/drm_modeset_lock.c
> index f33ebe638a28..61146f5b4f56 100644
> --- a/drivers/gpu/drm/drm_modeset_lock.c
> +++ b/drivers/gpu/drm/drm_modeset_lock.c
> @@ -37,7 +37,7 @@
>   *
>   * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
>   *
> - * The basic usage pattern is to:
> + * The basic usage pattern is to::
>   *
>   *     drm_modeset_acquire_init(&ctx)
>   *     retry:
> diff --git a/drivers/gpu/drm/drm_vma_manager.c b/drivers/gpu/drm/drm_vma_manager.c
> index 2f2ecde8285b..f306c8855978 100644
> --- a/drivers/gpu/drm/drm_vma_manager.c
> +++ b/drivers/gpu/drm/drm_vma_manager.c
> @@ -127,6 +127,9 @@ EXPORT_SYMBOL(drm_vma_offset_manager_destroy);
>   * used to implement weakly referenced lookups using kref_get_unless_zero().
>   *
>   * Example:
> + *
> + * ::
> + *
>   *     drm_vma_offset_lock_lookup(mgr);
>   *     node = drm_vma_offset_lookup_locked(mgr);
>   *     if (node)
> diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
> index 216cc4ba74ee..d25dd1d694bc 100644
> --- a/drivers/gpu/drm/i915/i915_reg.h
> +++ b/drivers/gpu/drm/i915/i915_reg.h
> @@ -886,7 +886,7 @@ enum skl_disp_power_wells {
>   * PLLs can be routed to any transcoder A/B/C.
>   *
>   * 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)
> diff --git a/drivers/gpu/drm/i915/i915_vgpu.c b/drivers/gpu/drm/i915/i915_vgpu.c
> index d5a7a5e7ee7e..004326291854 100644
> --- a/drivers/gpu/drm/i915/i915_vgpu.c
> +++ b/drivers/gpu/drm/i915/i915_vgpu.c
> @@ -150,28 +150,28 @@ static int vgt_balloon_space(struct drm_mm *mm,
>   * of its graphic space being zero. Yet there are some portions ballooned out(
>   * the shadow part, which are marked as reserved by drm allocator). From the
>   * host point of view, the graphic address space is partitioned by multiple
> - * vGPUs in different VMs.
> + * vGPUs in different VMs. ::
>   *
>   *                        vGPU1 view         Host view
>   *             0 ------> +-----------+     +-----------+
> - *               ^       |///////////|     |   vGPU3   |
> - *               |       |///////////|     +-----------+
> - *               |       |///////////|     |   vGPU2   |
> + *               ^       |###########|     |   vGPU3   |
> + *               |       |###########|     +-----------+
> + *               |       |###########|     |   vGPU2   |
>   *               |       +-----------+     +-----------+
>   *        mappable GM    | available | ==> |   vGPU1   |
>   *               |       +-----------+     +-----------+
> - *               |       |///////////|     |           |
> - *               v       |///////////|     |   Host    |
> + *               |       |###########|     |           |
> + *               v       |###########|     |   Host    |
>   *               +=======+===========+     +===========+
> - *               ^       |///////////|     |   vGPU3   |
> - *               |       |///////////|     +-----------+
> - *               |       |///////////|     |   vGPU2   |
> + *               ^       |###########|     |   vGPU3   |
> + *               |       |###########|     +-----------+
> + *               |       |###########|     |   vGPU2   |
>   *               |       +-----------+     +-----------+
>   *      unmappable GM    | available | ==> |   vGPU1   |
>   *               |       +-----------+     +-----------+
> - *               |       |///////////|     |           |
> - *               |       |///////////|     |   Host    |
> - *               v       |///////////|     |           |
> + *               |       |###########|     |           |
> + *               |       |###########|     |   Host    |
> + *               v       |###########|     |           |
>   * total GM size ------> +-----------+     +-----------+
>   *
>   * Returns:
> diff --git a/include/drm/drm_modes.h b/include/drm/drm_modes.h
> index 625966a906f2..ff481770d76b 100644
> --- a/include/drm/drm_modes.h
> +++ b/include/drm/drm_modes.h
> @@ -169,6 +169,8 @@ enum drm_mode_status {
>   *
>   * The horizontal and vertical timings are defined per the following diagram.
>   *
> + * ::
> + *
>   *
>   *               Active                 Front           Sync           Back
>   *              Region                 Porch                          Porch

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting
  2016-05-31 21:11 [PATCH 6/6] " Daniel Vetter
@ 2016-06-01  8:46 ` Daniel Vetter
  2016-06-01  9:46   ` Jani Nikula
  2016-06-02 14:29   ` Daniel Vetter
  0 siblings, 2 replies; 8+ messages in thread
From: Daniel Vetter @ 2016-06-01  8:46 UTC (permalink / raw)
  To: DRI Development; +Cc: Daniel Vetter, Daniel Vetter

There's still something very fishy going on with some of these, e.g.
the drm_modeset_lock Example: and the "Standard GTF Parameters:" Line
somehow get treated as heading when just appending a :: at the end of
those lines. But it seems to work everywhere else. Maybe the
kernel-doc heading generation logic is still a bit wonky?

v2: Found more. Also s/\//#/ in the vgpu ascii-art - sphinx treats
those as comments and switch to variable-width, which wreaks the
layout.

Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
---
 drivers/gpu/drm/drm_bridge.c        |  2 +-
 drivers/gpu/drm/drm_fb_cma_helper.c |  2 +-
 drivers/gpu/drm/drm_fops.c          |  2 +-
 drivers/gpu/drm/drm_modes.c         |  5 ++++-
 drivers/gpu/drm/drm_modeset_lock.c  |  2 +-
 drivers/gpu/drm/drm_vma_manager.c   |  3 +++
 drivers/gpu/drm/i915/i915_reg.h     |  2 +-
 drivers/gpu/drm/i915/i915_vgpu.c    | 24 ++++++++++++------------
 include/drm/drm_modes.h             |  2 ++
 9 files changed, 26 insertions(+), 18 deletions(-)

diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index b3654404abd0..255543086590 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -36,7 +36,7 @@
  * encoder chain.
  *
  * A bridge is always attached to a single &drm_encoder at a time, but can be
- * either connected to it directly, or through an intermediate bridge:
+ * either connected to it directly, or through an intermediate bridge::
  *
  *     encoder ---> bridge B ---> bridge A
  *
diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c
index 2b33b191a172..c50a0ba6fdba 100644
--- a/drivers/gpu/drm/drm_fb_cma_helper.c
+++ b/drivers/gpu/drm/drm_fb_cma_helper.c
@@ -52,7 +52,7 @@ struct drm_fbdev_cma {
  * will be set up automatically. dirty() is called by
  * drm_fb_helper_deferred_io() in process context (struct delayed_work).
  *
- * Example fbdev deferred io code:
+ * Example fbdev deferred io code::
  *
  *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
  *                                      struct drm_file *file_priv,
diff --git a/drivers/gpu/drm/drm_fops.c b/drivers/gpu/drm/drm_fops.c
index 5921b203503a..323c238fcac7 100644
--- a/drivers/gpu/drm/drm_fops.c
+++ b/drivers/gpu/drm/drm_fops.c
@@ -68,7 +68,7 @@ DEFINE_MUTEX(drm_global_mutex);
  * specific implementations. For GEM-based drivers this is drm_gem_mmap().
  *
  * No other file operations are supported by the DRM userspace API. Overall the
- * following is an example #file_operations structure:
+ * following is an example #file_operations structure::
  *
  *     static const example_drm_fops = {
  *             .owner = THIS_MODULE,
diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c
index e5e6f504d8cc..aae86c1857ec 100644
--- a/drivers/gpu/drm/drm_modes.c
+++ b/drivers/gpu/drm/drm_modes.c
@@ -552,7 +552,10 @@ EXPORT_SYMBOL(drm_gtf_mode_complex);
  * I also refer to the function of fb_get_mode in the file of
  * drivers/video/fbmon.c
  *
- * Standard GTF parameters:
+ * Standard GTF parameters
+ *
+ * ::
+ *
  *     M = 600
  *     C = 40
  *     K = 128
diff --git a/drivers/gpu/drm/drm_modeset_lock.c b/drivers/gpu/drm/drm_modeset_lock.c
index f33ebe638a28..61146f5b4f56 100644
--- a/drivers/gpu/drm/drm_modeset_lock.c
+++ b/drivers/gpu/drm/drm_modeset_lock.c
@@ -37,7 +37,7 @@
  *
  * For basic principles of &ww_mutex, see: Documentation/locking/ww-mutex-design.txt
  *
- * The basic usage pattern is to:
+ * The basic usage pattern is to::
  *
  *     drm_modeset_acquire_init(&ctx)
  *     retry:
diff --git a/drivers/gpu/drm/drm_vma_manager.c b/drivers/gpu/drm/drm_vma_manager.c
index 2f2ecde8285b..f306c8855978 100644
--- a/drivers/gpu/drm/drm_vma_manager.c
+++ b/drivers/gpu/drm/drm_vma_manager.c
@@ -127,6 +127,9 @@ EXPORT_SYMBOL(drm_vma_offset_manager_destroy);
  * used to implement weakly referenced lookups using kref_get_unless_zero().
  *
  * Example:
+ *
+ * ::
+ *
  *     drm_vma_offset_lock_lookup(mgr);
  *     node = drm_vma_offset_lookup_locked(mgr);
  *     if (node)
diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h
index 216cc4ba74ee..d25dd1d694bc 100644
--- a/drivers/gpu/drm/i915/i915_reg.h
+++ b/drivers/gpu/drm/i915/i915_reg.h
@@ -886,7 +886,7 @@ enum skl_disp_power_wells {
  * PLLs can be routed to any transcoder A/B/C.
  *
  * 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)
diff --git a/drivers/gpu/drm/i915/i915_vgpu.c b/drivers/gpu/drm/i915/i915_vgpu.c
index d5a7a5e7ee7e..004326291854 100644
--- a/drivers/gpu/drm/i915/i915_vgpu.c
+++ b/drivers/gpu/drm/i915/i915_vgpu.c
@@ -150,28 +150,28 @@ static int vgt_balloon_space(struct drm_mm *mm,
  * of its graphic space being zero. Yet there are some portions ballooned out(
  * the shadow part, which are marked as reserved by drm allocator). From the
  * host point of view, the graphic address space is partitioned by multiple
- * vGPUs in different VMs.
+ * vGPUs in different VMs. ::
  *
  *                        vGPU1 view         Host view
  *             0 ------> +-----------+     +-----------+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *        mappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               v       |///////////|     |   Host    |
+ *               |       |###########|     |           |
+ *               v       |###########|     |   Host    |
  *               +=======+===========+     +===========+
- *               ^       |///////////|     |   vGPU3   |
- *               |       |///////////|     +-----------+
- *               |       |///////////|     |   vGPU2   |
+ *               ^       |###########|     |   vGPU3   |
+ *               |       |###########|     +-----------+
+ *               |       |###########|     |   vGPU2   |
  *               |       +-----------+     +-----------+
  *      unmappable GM    | available | ==> |   vGPU1   |
  *               |       +-----------+     +-----------+
- *               |       |///////////|     |           |
- *               |       |///////////|     |   Host    |
- *               v       |///////////|     |           |
+ *               |       |###########|     |           |
+ *               |       |###########|     |   Host    |
+ *               v       |###########|     |           |
  * total GM size ------> +-----------+     +-----------+
  *
  * Returns:
diff --git a/include/drm/drm_modes.h b/include/drm/drm_modes.h
index 625966a906f2..ff481770d76b 100644
--- a/include/drm/drm_modes.h
+++ b/include/drm/drm_modes.h
@@ -169,6 +169,8 @@ enum drm_mode_status {
  *
  * The horizontal and vertical timings are defined per the following diagram.
  *
+ * ::
+ *
  *
  *               Active                 Front           Sync           Back
  *              Region                 Porch                          Porch
-- 
2.8.1

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

^ permalink raw reply related	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2016-06-06  7:10 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <890e1aabffc12303f8c110aa5686ad51b01eed6b>
2016-06-01 14:44 ` [PATCH] drm/doc: Switch to sphinx/rst fixed-width quoting Daniel Vetter
2016-06-06  7:10   ` Jani Nikula
2016-05-31 21:11 [PATCH 6/6] " Daniel Vetter
2016-06-01  8:46 ` [PATCH] " Daniel Vetter
2016-06-01  9:46   ` Jani Nikula
2016-06-01 13:33     ` Daniel Vetter
2016-06-01 13:46       ` Jani Nikula
2016-06-01 14:44         ` Daniel Vetter
2016-06-02 14:29   ` Daniel Vetter

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.