* [PATCH] docs: Fix warning:Error in "code-block" directive
@ 2023-06-02 21:51 Madhumitha Prabakaran
2023-06-03 1:20 ` Bagas Sanjaya
0 siblings, 1 reply; 5+ messages in thread
From: Madhumitha Prabakaran @ 2023-06-02 21:51 UTC (permalink / raw)
To: rafael, lenb, linux-acpi, linux-kernel, skhan; +Cc: ivan.orlov0322
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(-)
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",
--
2.25.1
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Fix warning:Error in "code-block" directive
2023-06-02 21:51 [PATCH] docs: Fix warning:Error in "code-block" directive Madhumitha Prabakaran
@ 2023-06-03 1:20 ` Bagas Sanjaya
2023-06-03 1:41 ` Randy Dunlap
0 siblings, 1 reply; 5+ messages in thread
From: Bagas Sanjaya @ 2023-06-03 1:20 UTC (permalink / raw)
To: Madhumitha Prabakaran, rafael, lenb, linux-acpi, linux-kernel,
skhan, Linux Documentation
Cc: ivan.orlov0322
[-- Attachment #1: Type: text/plain, Size: 778 bytes --]
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.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Fix warning:Error in "code-block" directive
2023-06-03 1:20 ` Bagas Sanjaya
@ 2023-06-03 1:41 ` Randy Dunlap
2023-06-03 4:04 ` Akira Yokosawa
0 siblings, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2023-06-03 1:41 UTC (permalink / raw)
To: Bagas Sanjaya, Madhumitha Prabakaran, rafael, lenb, linux-acpi,
linux-kernel, skhan, Linux Documentation
Cc: ivan.orlov0322
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.
--
~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Fix warning:Error in "code-block" directive
2023-06-03 1:41 ` Randy Dunlap
@ 2023-06-03 4:04 ` Akira Yokosawa
[not found] ` <CAPNSgDiZiv6VJcX66DaQjHkLjd3ZxhkBcXzo7UU5LUD2hCx9Sw@mail.gmail.com>
0 siblings, 1 reply; 5+ messages in thread
From: Akira Yokosawa @ 2023-06-03 4:04 UTC (permalink / raw)
To: rdunlap
Cc: bagasdotme, ivan.orlov0322, lenb, linux-acpi, linux-doc,
linux-kernel, madhumithabiw, rafael, skhan, Akira Yokosawa
On Fri, 2 Jun 2023 18:41:46 -0700, Randy Dunlap wrote:
> 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.
Right.
In Sphinx changelog, "Features added" for 2.0.0b1 [1] lists this:
#1851: Allow to omit an argument for code-block directive. If omitted,
it follows highlight or highlight_language
[1]: https://www.sphinx-doc.org/en/master/changes.html#id1306
Pre-2.0 Sphinx is now deprecated.
See commit 31abfdda6527 ("docs: Deprecate use of Sphinx < 2.4.x").
Thanks, Akira
>
> --
> ~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: Fwd: [PATCH] docs: Fix warning:Error in "code-block" directive
[not found] ` <CAPNSgDiZiv6VJcX66DaQjHkLjd3ZxhkBcXzo7UU5LUD2hCx9Sw@mail.gmail.com>
@ 2023-06-03 22:55 ` Madhumitha Prabakaran
0 siblings, 0 replies; 5+ messages in thread
From: Madhumitha Prabakaran @ 2023-06-03 22:55 UTC (permalink / raw)
To: rdunlap, bagasdotme, ivan.orlov0322, lenb, linux-acpi, linux-doc,
linux-kernel, rafael, skhan, Akira Yokosawa
Cc: madhumithabiw
On Sat, Jun 03, 2023 at 01:52:46PM -0500, Madhumitha Prabakaran wrote:
> Date: Sat, 3 Jun 2023 13:52:46 -0500
> From: Madhumitha Prabakaran <madhumithabiw@gmail.com>
> To: Madhumitha Prabakaran <madhumithabiw@gmail.com>
> Subject: Fwd: [PATCH] docs: Fix warning:Error in "code-block" directive
>
> ---------- Forwarded message ---------
> From: Akira Yokosawa <akiyks@gmail.com>
> Date: Fri, 2 Jun 2023 at 23:04
> Subject: Re: [PATCH] docs: Fix warning:Error in "code-block" directive
> To: <rdunlap@infradead.org>
> Cc: <bagasdotme@gmail.com>, <ivan.orlov0322@gmail.com>, <lenb@kernel.org>, <
> linux-acpi@vger.kernel.org>, <linux-doc@vger.kernel.org>, <
> linux-kernel@vger.kernel.org>, <madhumithabiw@gmail.com>, <rafael@kernel.org>,
> <skhan@linuxfoundation.org>, Akira Yokosawa <akiyks@gmail.com>
>
>
> On Fri, 2 Jun 2023 18:41:46 -0700, Randy Dunlap wrote:
> > 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,
I did executed "make htmldocs" on sphinx-build 1.8.5 and sphinx_2.4.4, which throws the warning but on executing the same on sphinx_7.1.0 - one
can't see the warning
I skip the patch.
Thanks
> >> 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.
>
Yeah, your are right.
On executing the make htmldocs, it clearly throws the warning
"WARNING: support for Sphinx < 2.4 will be removed soon"
My ignorance.
Thanks for pointing it.
> Right.
>
> In Sphinx changelog, "Features added" for 2.0.0b1 [1] lists this:
>
> #1851: Allow to omit an argument for code-block directive. If omitted,
> it follows highlight or highlight_language
>
> [1]: https://www.sphinx-doc.org/en/master/changes.html#id1306
>
Thanks for the changelog reference and reasoning.
Madhumitha
> Pre-2.0 Sphinx is now deprecated.
> See commit 31abfdda6527 ("docs: Deprecate use of Sphinx < 2.4.x").
>
> Thanks, Akira
>
> >
> > --
> > ~Randy
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-06-03 22:55 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-06-02 21:51 [PATCH] docs: Fix warning:Error in "code-block" directive Madhumitha Prabakaran
2023-06-03 1:20 ` Bagas Sanjaya
2023-06-03 1:41 ` Randy Dunlap
2023-06-03 4:04 ` Akira Yokosawa
[not found] ` <CAPNSgDiZiv6VJcX66DaQjHkLjd3ZxhkBcXzo7UU5LUD2hCx9Sw@mail.gmail.com>
2023-06-03 22:55 ` Fwd: " Madhumitha Prabakaran
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.