[PATCH] docs: drm/amdgpu: Resolve build warnings

[Alex Deucher]

On Mon, Sep 16, 2019 at 3:28 AM Adam Zerella <adam.zerella at gmail.com> wrote:
>
> Some of the documentation formatting could be improved
> which will resolve some Sphinx amdgpu build warnings e.g
>
> WARNING: Unexpected indentation.
> WARNING: Block quote ends without a blank line; unexpected unindent.
> WARNING: Inline emphasis start-string without end-string.
>
> Signed-off-by: Adam Zerella <adam.zerella at gmail.com>

Applied.  thanks!

Alex

> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c | 11 ++++---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c  |  4 +--
>  drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c | 44 +++++++++++++++----------
>  3 files changed, 35 insertions(+), 24 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> index bdf849da32e4..9ce5aa82ee53 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
> @@ -243,10 +243,13 @@ module_param_named(msi, amdgpu_msi, int, 0444);
>   *
>   * The format can be [Non-Compute] or [GFX,Compute,SDMA,Video]. That is there can be one or
>   * multiple values specified. 0 and negative values are invalidated. They will be adjusted
> - * to default timeout.
> - *  - With one value specified, the setting will apply to all non-compute jobs.
> - *  - With multiple values specified, the first one will be for GFX. The second one is for Compute.
> - *    And the third and fourth ones are for SDMA and Video.
> + * to the default timeout.
> + *
> + * - With one value specified, the setting will apply to all non-compute jobs.
> + * - With multiple values specified, the first one will be for GFX.
> + *   The second one is for Compute. The third and fourth ones are
> + *   for SDMA and Video.
> + *
>   * By default(with no lockup_timeout settings), the timeout for all non-compute(GFX, SDMA and Video)
>   * jobs is 10000. And there is no timeout enforced on compute jobs.
>   */
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
> index 03930313c263..bdad0347fdd8 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
> @@ -2196,9 +2196,9 @@ static ssize_t amdgpu_hwmon_show_mclk_label(struct device *dev,
>   *
>   * - fan1_input: fan speed in RPM
>   *
> - * - fan[1-*]_target: Desired fan speed Unit: revolution/min (RPM)
> + * - fan[1-\*]_target: Desired fan speed Unit: revolution/min (RPM)
>   *
> - * - fan[1-*]_enable: Enable or disable the sensors.1: Enable 0: Disable
> + * - fan[1-\*]_enable: Enable or disable the sensors.1: Enable 0: Disable
>   *
>   * hwmon interfaces for GPU clocks:
>   *
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> index 016ea274b955..373d24156c13 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> @@ -210,29 +210,36 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
>   *
>   * Second member: struct ras_debug_if::op.
>   * It has three kinds of operations.
> - *  0: disable RAS on the block. Take ::head as its data.
> - *  1: enable RAS on the block. Take ::head as its data.
> - *  2: inject errors on the block. Take ::inject as its data.
> + *
> + * - 0: disable RAS on the block. Take ::head as its data.
> + * - 1: enable RAS on the block. Take ::head as its data.
> + * - 2: inject errors on the block. Take ::inject as its data.
>   *
>   * How to use the interface?
>   * programs:
>   * copy the struct ras_debug_if in your codes and initialize it.
>   * write the struct to the control node.
>   *
> - * bash:
> - * echo op block [error [sub_blcok address value]] > .../ras/ras_ctrl
> - *     op: disable, enable, inject
> - *             disable: only block is needed
> - *             enable: block and error are needed
> - *             inject: error, address, value are needed
> - *     block: umc, smda, gfx, .........
> - *             see ras_block_string[] for details
> - *     error: ue, ce
> - *             ue: multi_uncorrectable
> - *             ce: single_correctable
> - *     sub_block: sub block index, pass 0 if there is no sub block
> + * .. code-block:: bash
> + *
> + *     echo op block [error [sub_blcok address value]] > .../ras/ras_ctrl
> + *
> + * op: disable, enable, inject
> + *     disable: only block is needed
> + *     enable: block and error are needed
> + *     inject: error, address, value are needed
> + * block: umc, smda, gfx, .........
> + *     see ras_block_string[] for details
> + * error: ue, ce
> + *     ue: multi_uncorrectable
> + *     ce: single_correctable
> + * sub_block:
> + *     sub block index, pass 0 if there is no sub block
> + *
> + * here are some examples for bash commands:
> + *
> + * .. code-block:: bash
>   *
> - * here are some examples for bash commands,
>   *     echo inject umc ue 0x0 0x0 0x0 > /sys/kernel/debug/dri/0/ras/ras_ctrl
>   *     echo inject umc ce 0 0 0 > /sys/kernel/debug/dri/0/ras/ras_ctrl
>   *     echo disable umc > /sys/kernel/debug/dri/0/ras/ras_ctrl
> @@ -245,8 +252,9 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
>   * For inject, please check corresponding err count at
>   * /sys/class/drm/card[0/1/2...]/device/ras/[gfx/sdma/...]_err_count
>   *
> - * NOTE: operation is only allowed on blocks which are supported.
> - * Please check ras mask at /sys/module/amdgpu/parameters/ras_mask
> + * .. note::
> + *     Operation is only allowed on blocks which are supported.
> + *     Please check ras mask at /sys/module/amdgpu/parameters/ras_mask
>   */
>  static ssize_t amdgpu_ras_debugfs_ctrl_write(struct file *f, const char __user *buf,
>                 size_t size, loff_t *pos)
> --
> 2.21.0
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx