| Message ID | 20230602215102.GA220958@madhu-kernel |
|---|---|
| State | New |
| Headers | show |
| Series | docs: Fix warning:Error in "code-block" directive | expand |
On 6/2/23 18:20, Bagas Sanjaya wrote: > 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". >> >> <snipped> ... >> Result code: >> ------------ >> >> -.. 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. I also don't see any such warnings so I don't see a need for this patch. My wild guess is that some older version of Sphinx was being used.
diff --git a/Documentation/firmware-guide/acpi/chromeos-acpi-device.rst b/Documentation/firmware-guide/acpi/chromeos-acpi-device.rst index f37fc90ce340..27292299ad17 100644 --- a/Documentation/firmware-guide/acpi/chromeos-acpi-device.rst +++ b/Documentation/firmware-guide/acpi/chromeos-acpi-device.rst @@ -131,7 +131,7 @@ None Result code: ------------ -.. code-block:: +.. code-block:: text Package { Reserved1 @@ -192,7 +192,7 @@ None Result code: ------------ -.. code-block:: +.. code-block:: text Package { Package { @@ -265,7 +265,7 @@ None Result code: ------------ -.. code-block:: +.. code-block:: text Package { NV Storage Block Offset //DWORD @@ -347,7 +347,7 @@ A package containing a list of null-terminated ASCII strings, one for each contr supported by the Chrome OS hardware device, not including the MLST method itself. For this version of the specification, the result is: -.. code-block:: +.. code-block:: text Package { "CHSW",
Fix the error in "code-block" directive by providing the argument as "text". Signed-off-by: Madhumitha Prabakaran <madhumithabiw@gmail.com> --- .../firmware-guide/acpi/chromeos-acpi-device.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)