linux-kernel - Re: [REBASE PATCH v5 01/17] docs: qcom: Add qualcomm minidump guide

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZQF_9-nX47QUCycO@debian.me>
Date:   Wed, 13 Sep 2023 16:25:11 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Mukesh Ojha <quic_mojha@...cinc.com>, <corbet@....net>,
        <agross@...nel.org>, <andersson@...nel.org>,
        <konrad.dybcio@...aro.org>, <robh+dt@...nel.org>,
        <krzysztof.kozlowski+dt@...aro.org>, <conor+dt@...nel.org>,
        <keescook@...omium.org>, <tony.luck@...el.com>,
        <gpiccoli@...lia.com>, <mathieu.poirier@...aro.org>,
        <catalin.marinas@....com>, <will@...nel.org>,
        <linus.walleij@...aro.org>, <andy.shevchenko@...il.com>,
        <vigneshr@...com>, <nm@...com>, <matthias.bgg@...il.com>,
        <kgene@...nel.org>, <alim.akhtar@...sung.com>,
        <bmasney@...hat.com>, <quic_tsoni@...cinc.com>
Cc:     <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <linux-arm-msm@...r.kernel.org>, <linux-hardening@...r.kernel.org>,
        <linux-remoteproc@...r.kernel.org>,
        <linux-arm-kernel@...ts.infradead.org>,
        <linux-gpio@...r.kernel.org>, <linux-mediatek@...ts.infradead.org>,
        <linux-samsung-soc@...r.kernel.org>, <kernel@...cinc.com>
Subject: Re: [REBASE PATCH v5 01/17] docs: qcom: Add qualcomm minidump guide

On Mon, Sep 11, 2023 at 04:23:43PM +0530, Mukesh Ojha wrote:
> +Qualcomm APSS Minidump kernel driver concept
> +--------------------------------------------
> +::
> +
> <snipped>...
> +Dump collection
> +---------------
> +
> +	+-----------+
> +	|           |
> +	|           |         +------+
> +	|           |         |      |
> +	|           |         +--+---+ Product(Qualcomm SoC)
> +	+-----------+             |
> +	|+++++++++++|<------------+
> +	|+++++++++++|    usb cable
> +	+-----------+
> +            x86_64 PC
> +

Sphinx reports htmldocs warnings:

/home/bagas/repo/linux-kernel/Documentation/admin-guide/qcom_minidump.rst:100: WARNING: Literal block expected; none found.
/home/bagas/repo/linux-kernel/Documentation/admin-guide/qcom_minidump.rst:243: WARNING: Unexpected indentation.
/home/bagas/repo/linux-kernel/Documentation/admin-guide/qcom_minidump.rst:234: WARNING: Malformed table.

+-----------+
|           |
|           |         +------+
|           |         |      |
|           |         +--+---+ Product(Qualcomm SoC)
+-----------+             |
|+++++++++++|<------------+
|+++++++++++|    usb cable
+-----------+
/home/bagas/repo/linux-kernel/Documentation/admin-guide/qcom_minidump.rst:243: WARNING: Blank line required after table.

I have to apply the fixup:

---- >8 ----
diff --git a/Documentation/admin-guide/qcom_minidump.rst b/Documentation/admin-guide/qcom_minidump.rst
index 20202da8ca40b9..5709a3853ae7ea 100644
--- a/Documentation/admin-guide/qcom_minidump.rst
+++ b/Documentation/admin-guide/qcom_minidump.rst
@@ -95,7 +95,6 @@ could be anywhere scattered in the DDR.
 
 Qualcomm APSS Minidump kernel driver concept
 --------------------------------------------
-::
 
 Qualcomm APSS minidump kernel driver adds the capability to add Linux
 region to be dumped as part of RAM dump collection. At the moment,
@@ -231,6 +230,8 @@ respective dump as per set download mode.
 Dump collection
 ---------------
 
+::
+
 	+-----------+
 	|           |
 	|           |         +------+

Thanks.

-- 
An old man doll... just what I always wanted! - Clara