lkml.org 
[lkml]   [2022]   [Sep]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v3 15/37] drm/i915: intel_pm.c: fix some ascii artwork at kernel-doc
    Date
    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
    \
     
     \ /
      Last update: 2022-09-09 09:38    [W:4.175 / U:0.036 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site