Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sat, 3 Jun 2023 08:20:44 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Madhumitha Prabakaran <madhumithabiw@gmail.com>, rafael@kernel.org,
        lenb@kernel.org, linux-acpi@vger.kernel.org,
        linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
        Linux Documentation <linux-doc@vger.kernel.org>
Cc:     ivan.orlov0322@gmail.com
Subject: Re: [PATCH] docs: Fix warning:Error in "code-block" directive
Message-ID: <ZHqVbIouMkvM4OAs@debian.me>
References: <20230602215102.GA220958@madhu-kernel>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="TMDPLLkdIOvqcUM1"
Content-Disposition: inline
In-Reply-To: <20230602215102.GA220958@madhu-kernel>
Precedence: bulk


--TMDPLLkdIOvqcUM1
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Fri, Jun 02, 2023 at 04:51:02PM -0500, Madhumitha Prabakaran wrote:
> Fix the error in "code-block" directive by providing the
> argument as "text".
>=20
> <snipped> ...
>  Result code:
>  ------------
> =20
> -.. code-block::
> +.. code-block:: text

Nope.

I don't see error you mention in this patch when making htmldocs on my
computer (my setup is pretty standard: see
Documentation/doc-guide/sphinx.rst). This patch is unneccessary, though,
unless you have code snippets in some language (e.g. C, where passing
language name to code-block:: syntax-highlight it). Result code outputs,
on the other hand, are generic text with no definitive syntax, hence
you can omit language name.

Thanks.

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

--TMDPLLkdIOvqcUM1
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZHqVZgAKCRD2uYlJVVFO
o+pPAQC1MK/h/J4QW3qWmnbpauQ0Cr0k33lf8QV+hDnWKCkEpQD/QTYX820N+B3c
/0rBRMzVYbE7FluBIIK+7tJ0f+ahswg=
=JKVF
-----END PGP SIGNATURE-----

--TMDPLLkdIOvqcUM1--