Intel-GFX Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: David Airlie <airlied@linux.ie>,
	intel-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org,
	dri-devel@lists.freedesktop.org, Daniel Vetter <daniel@ffwll.ch>,
	Rodrigo Vivi <rodrigo.vivi@intel.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: [Intel-gfx] [PATCH v3 15/37] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc
Date: Fri,  9 Sep 2022 09:34:22 +0200	[thread overview]
Message-ID: <0c993e585f1fbc26cdd86c1325fdfd7f7c969f10.1662708705.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1662708705.git.mchehab@kernel.org>

Preserving ascii artwork on kernel-docs is tricky, as it needs
to respect both the Sphinx rules and be properly parsed by
kernel-doc script.

The Sphinx syntax require code-blocks, which is:

	::

followed by a blank line and indented lines.

But kernel-doc only works fine if the first and the last line
are indented with the same amount of spaces.

Also, a "\" at the end means that the next line should be merged
with the first one.

Change the ascii artwork to be on code-blocks, starting all
lines at the same characters and not ending with a backslash.

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/37] at: https://lore.kernel.org/all/cover.1662708705.git.mchehab@kernel.org/

 drivers/gpu/drm/i915/intel_pm.c | 33 ++++++++++++++++++---------------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/drivers/gpu/drm/i915/intel_pm.c b/drivers/gpu/drm/i915/intel_pm.c
index eb9c54bbf51f..1f5e520a6728 100644
--- a/drivers/gpu/drm/i915/intel_pm.c
+++ b/drivers/gpu/drm/i915/intel_pm.c
@@ -683,18 +683,20 @@ static const struct intel_watermark_params i845_wm_info = {
  * FIFO is relatively small compared to the amount of data
  * fetched.
  *
- * The FIFO level vs. time graph might look something like:
+ * The FIFO level vs. time graph might look something like::
  *
- *   |\   |\
- *   | \  | \
- * __---__---__ (- plane active, _ blanking)
- * -> time
+ *   ^
+ *   |   |\   |\      (                          )
+ *   |   | \  | \     (                          )
+ *   |   __---__---__ (- plane active, _ blanking)
+ *   +-------------------> time
  *
- * or perhaps like this:
+ * or perhaps like this::
  *
- *   |\|\  |\|\
- * __----__----__ (- plane active, _ blanking)
- * -> time
+ *   ^
+ *   |     |\|\  |\|\   (                          )
+ *   |   __----__----__ (- plane active, _ blanking)
+ *   +-------------------> time
  *
  * Returns:
  * The watermark in bytes
@@ -730,13 +732,14 @@ static unsigned int intel_wm_method1(unsigned int pixel_rate,
  * FIFO is relatively large compared to the amount of data
  * fetched.
  *
- * The FIFO level vs. time graph might look something like:
+ * The FIFO level vs. time graph might look something like::
  *
- *    |\___       |\___
- *    |    \___   |    \___
- *    |        \  |        \
- * __ --__--__--__--__--__--__ (- plane active, _ blanking)
- * -> time
+ *   ^
+ *   |     |\___       |\___        (                          )
+ *   |     |    \___   |    \___    (                          )
+ *   |     |        \  |        \   (                          )
+ *   |  __ --__--__--__--__--__--__ (- plane active, _ blanking)
+ *   +---------------------------------> time
  *
  * Returns:
  * The watermark in bytes
-- 
2.37.3


  parent reply	other threads:[~2022-09-09  7:36 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-09  7:34 [Intel-gfx] [PATCH v3 00/37] drm/i915: fix kernel-doc issues Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 01/37] drm/i915: fix kernel-doc trivial warnings on i915/*.[ch] files Mauro Carvalho Chehab
2022-09-16 14:03   ` Gwan-gyeong Mun
2022-09-26  9:19     ` Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 02/37] drm/i915: display: fix kernel-doc markup warnings Mauro Carvalho Chehab
2022-09-16 12:35   ` Gwan-gyeong Mun
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 03/37] drm/i915: gt: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 04/37] drm/i915: gvt: fix kernel-doc trivial warnings Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 05/37] drm/i915: gem: fix some Kernel-doc issues Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 06/37] drm/i915: intel_wakeref.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 07/37] drm/i915: i915_gem_ttm: fix a kernel-doc markup Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 08/37] drm/i915: i915_gem_ttm_pm.c: fix kernel-doc markups Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 09/37] drm/i915: gem: add kernel-doc description for some function parameters Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 10/37] drm/i915: i915_gpu_error.c: document dump_flags Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 11/37] drm/i915: document kernel-doc trivial issues Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 12/37] drm/i915: intel_dp_link_training.c: fix kernel-doc markup Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 13/37] drm/i915: intel_fb: fix a kernel-doc issue with Sphinx Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 14/37] drm/i915: skl_scaler: fix return value kernel-doc markup Mauro Carvalho Chehab
2022-09-09  7:34 ` Mauro Carvalho Chehab [this message]
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 16/37] drm/i915: i915_gem_region.h: fix i915_gem_apply_to_region_ops doc Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 17/37] drm/i915: i915_gem_wait.c: fix a kernel-doc markup Mauro Carvalho Chehab
2022-09-12  1:22   ` Andi Shyti
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 18/37] drm/i915: fix i915_gem_ttm_move.c DOC: markup Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 19/37] drm/i915: stop using kernel-doc markups for something else Mauro Carvalho Chehab
2022-09-12  1:23   ` Andi Shyti
2022-09-12 15:09   ` Matt Roper
2022-09-12 16:47     ` Mauro Carvalho Chehab
2022-09-12 17:19       ` Matt Roper
2022-09-26  8:25         ` Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 20/37] drm/i915: dvo_ch7xxx.c: use SPDX header Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 21/37] drm/i915: dvo_sil164.c: " Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 22/37] drm/i915: i915_vma_resource.c: fix some kernel-doc markups Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 23/37] drm/i915: i915_gem.c fix a kernel-doc issue Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 24/37] drm/i915: i915_scatterlist.h: fix some kernel-doc markups Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 25/37] drm/i915: i915_deps: use a shorter title markup Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 26/37] docs: gpu: i915.rst: display: add kernel-doc markups Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 27/37] docs: gpu: i915.rst: gt: add more " Mauro Carvalho Chehab
2022-09-09  9:06   ` Rodrigo Vivi
2022-09-26  9:45     ` Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 28/37] docs: gpu: i915.rst: GuC: " Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 29/37] docs: gpu: i915.rst: GVT: " Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 30/37] docs: gpu: i915.rst: PM: " Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 31/37] docs: gpu: i915.rst: GEM/TTM: " Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 32/37] docs: gpu: i915.rst: add the remaining kernel-doc markup files Mauro Carvalho Chehab
2022-09-09  9:10   ` Rodrigo Vivi
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 33/37] drm/i915 i915_gem_object_types.h: document struct i915_lut_handle Mauro Carvalho Chehab
2022-09-12  1:25   ` Andi Shyti
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 34/37] drm/i915: document struct drm_i915_gem_object Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 35/37] drm/i915: add descriptions for some RPM macros at intel_gt_pm.h Mauro Carvalho Chehab
2022-09-09  9:12   ` Rodrigo Vivi
2022-09-12  1:27   ` Andi Shyti
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 36/37] drm/i915: add GuC functions to the documentation Mauro Carvalho Chehab
2022-09-09  7:34 ` [Intel-gfx] [PATCH v3 37/37] drm/i915: be consistent with kernel-doc function declaration Mauro Carvalho Chehab
2022-09-09  9:13   ` Rodrigo Vivi
2022-09-09 10:41 ` [Intel-gfx] ✗ Fi.CI.SPARSE: warning for drm/i915: fix kernel-doc issues (rev3) Patchwork
2022-09-09 10:55 ` [Intel-gfx] ✗ Fi.CI.BAT: failure " Patchwork

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=0c993e585f1fbc26cdd86c1325fdfd7f7c969f10.1662708705.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=airlied@linux.ie \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=intel-gfx@lists.freedesktop.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rodrigo.vivi@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