[PATCH] Documentation: parport-lowlevel: Separate function listing code blocks

Bagas Sanjaya posted 1 patch 1 month, 1 week ago
Documentation/driver-api/parport-lowlevel.rst | 5 +++++
1 file changed, 5 insertions(+)
[PATCH] Documentation: parport-lowlevel: Separate function listing code blocks
Posted by Bagas Sanjaya 1 month, 1 week ago
Commit be9d0411f1608a ("parport-lowlevel.txt: standardize document
format") reSTify parport interface documentation but forgets to properly
mark function listing code blocks up. As such, these are rendered as
long-running normal paragraph instead.

Fix them by adding missing separator between the code block marker and
the listing.

Fixes: be9d0411f1608a ("parport-lowlevel.txt: standardize document format")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/driver-api/parport-lowlevel.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/driver-api/parport-lowlevel.rst b/Documentation/driver-api/parport-lowlevel.rst
index 0633d70ffda7fa..a907e279f509b4 100644
--- a/Documentation/driver-api/parport-lowlevel.rst
+++ b/Documentation/driver-api/parport-lowlevel.rst
@@ -7,6 +7,7 @@ PARPORT interface documentation
 Described here are the following functions:
 
 Global functions::
+
   parport_register_driver
   parport_unregister_driver
   parport_enumerate
@@ -34,6 +35,7 @@ Global functions::
 Port functions (can be overridden by low-level drivers):
 
   SPP::
+
     port->ops->read_data
     port->ops->write_data
     port->ops->read_status
@@ -46,17 +48,20 @@ Port functions (can be overridden by low-level drivers):
     port->ops->data_reverse
 
   EPP::
+
     port->ops->epp_write_data
     port->ops->epp_read_data
     port->ops->epp_write_addr
     port->ops->epp_read_addr
 
   ECP::
+
     port->ops->ecp_write_data
     port->ops->ecp_read_data
     port->ops->ecp_write_addr
 
   Other::
+
     port->ops->nibble_read_data
     port->ops->byte_read_data
     port->ops->compat_write_data

base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH] Documentation: parport-lowlevel: Separate function listing code blocks
Posted by Jonathan Corbet 1 month, 1 week ago
Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Commit be9d0411f1608a ("parport-lowlevel.txt: standardize document
> format") reSTify parport interface documentation but forgets to properly
> mark function listing code blocks up. As such, these are rendered as
> long-running normal paragraph instead.
>
> Fix them by adding missing separator between the code block marker and
> the listing.
>
> Fixes: be9d0411f1608a ("parport-lowlevel.txt: standardize document format")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/driver-api/parport-lowlevel.rst | 5 +++++
>  1 file changed, 5 insertions(+)

Applied, thanks.

jon
Re: [PATCH] Documentation: parport-lowlevel: Separate function listing code blocks
Posted by Randy Dunlap 1 month, 1 week ago

On 11/5/25 4:49 AM, Bagas Sanjaya wrote:
> Commit be9d0411f1608a ("parport-lowlevel.txt: standardize document
> format") reSTify parport interface documentation but forgets to properly
> mark function listing code blocks up. As such, these are rendered as
> long-running normal paragraph instead.
> 
> Fix them by adding missing separator between the code block marker and
> the listing.
> 
> Fixes: be9d0411f1608a ("parport-lowlevel.txt: standardize document format")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  Documentation/driver-api/parport-lowlevel.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/driver-api/parport-lowlevel.rst b/Documentation/driver-api/parport-lowlevel.rst
> index 0633d70ffda7fa..a907e279f509b4 100644
> --- a/Documentation/driver-api/parport-lowlevel.rst
> +++ b/Documentation/driver-api/parport-lowlevel.rst
> @@ -7,6 +7,7 @@ PARPORT interface documentation
>  Described here are the following functions:
>  
>  Global functions::
> +
>    parport_register_driver
>    parport_unregister_driver
>    parport_enumerate
> @@ -34,6 +35,7 @@ Global functions::
>  Port functions (can be overridden by low-level drivers):
>  
>    SPP::
> +
>      port->ops->read_data
>      port->ops->write_data
>      port->ops->read_status
> @@ -46,17 +48,20 @@ Port functions (can be overridden by low-level drivers):
>      port->ops->data_reverse
>  
>    EPP::
> +
>      port->ops->epp_write_data
>      port->ops->epp_read_data
>      port->ops->epp_write_addr
>      port->ops->epp_read_addr
>  
>    ECP::
> +
>      port->ops->ecp_write_data
>      port->ops->ecp_read_data
>      port->ops->ecp_write_addr
>  
>    Other::
> +
>      port->ops->nibble_read_data
>      port->ops->byte_read_data
>      port->ops->compat_write_data
> 
> base-commit: 27600b51fbc8b9a4eba18c8d88d7edb146605f3f

-- 
~Randy