diff mbox

[v2,38/53] mtdnand.rst: group the "::" with previous line

Message ID f341afe2fca77fbb258007dc9addb36784b4f252.1494935649.git.mchehab@s-opensource.com
State Not Applicable
Headers show

Commit Message

Mauro Carvalho Chehab May 16, 2017, 12:16 p.m. UTC
Group the :: with the previous paragraph, in order to make it
visually better when reading as a text file.

While here, replace:
	ored (with means "Covered or adorned with ore or metal")
by:
	OR-ed

To reflect its true meaning.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/driver-api/mtdnand.rst | 24 +++++++-----------------
 1 file changed, 7 insertions(+), 17 deletions(-)

Comments

Boris Brezillon May 16, 2017, 1:12 p.m. UTC | #1
On Tue, 16 May 2017 09:16:30 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:

> Group the :: with the previous paragraph, in order to make it
> visually better when reading as a text file.
> 
> While here, replace:
> 	ored (with means "Covered or adorned with ore or metal")
> by:
> 	OR-ed
> 
> To reflect its true meaning.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

Acked-by: Boris Brezillon <boris.brezillon@free-electrons.com>

> ---
>  Documentation/driver-api/mtdnand.rst | 24 +++++++-----------------
>  1 file changed, 7 insertions(+), 17 deletions(-)
> 
> diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
> index 8723175f955e..7c19795ebb4a 100644
> --- a/Documentation/driver-api/mtdnand.rst
> +++ b/Documentation/driver-api/mtdnand.rst
> @@ -843,10 +843,8 @@ Chip option constants
>  Constants for chip id table
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -These constants are defined in nand.h. They are ored together to
> -describe the chip functionality.
> -
> -::
> +These constants are defined in nand.h. They are OR-ed together to
> +describe the chip functionality::
>  
>      /* Buswitdh is 16 bit */
>      #define NAND_BUSWIDTH_16    0x00000002
> @@ -867,10 +865,8 @@ describe the chip functionality.
>  Constants for runtime options
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -These constants are defined in nand.h. They are ored together to
> -describe the functionality.
> -
> -::
> +These constants are defined in nand.h. They are OR-ed together to
> +describe the functionality::
>  
>      /* The hw ecc generator provides a syndrome instead a ecc value on read
>       * This can only work if we have the ecc bytes directly behind the
> @@ -881,9 +877,7 @@ describe the functionality.
>  ECC selection constants
>  -----------------------
>  
> -Use these constants to select the ECC algorithm.
> -
> -::
> +Use these constants to select the ECC algorithm::
>  
>      /* No ECC. Usage is not recommended ! */
>      #define NAND_ECC_NONE       0
> @@ -903,9 +897,7 @@ Hardware control related constants
>  ----------------------------------
>  
>  These constants describe the requested hardware access function when the
> -boardspecific hardware control function is called
> -
> -::
> +boardspecific hardware control function is called::
>  
>      /* Select the chip by setting nCE to low */
>      #define NAND_CTL_SETNCE     1
> @@ -929,9 +921,7 @@ Bad block table related constants
>  ---------------------------------
>  
>  These constants describe the options used for bad block table
> -descriptors.
> -
> -::
> +descriptors::
>  
>      /* Options for the bad block table descriptors */
>
diff mbox

Patch

diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
index 8723175f955e..7c19795ebb4a 100644
--- a/Documentation/driver-api/mtdnand.rst
+++ b/Documentation/driver-api/mtdnand.rst
@@ -843,10 +843,8 @@  Chip option constants
 Constants for chip id table
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These constants are defined in nand.h. They are ored together to
-describe the chip functionality.
-
-::
+These constants are defined in nand.h. They are OR-ed together to
+describe the chip functionality::
 
     /* Buswitdh is 16 bit */
     #define NAND_BUSWIDTH_16    0x00000002
@@ -867,10 +865,8 @@  describe the chip functionality.
 Constants for runtime options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These constants are defined in nand.h. They are ored together to
-describe the functionality.
-
-::
+These constants are defined in nand.h. They are OR-ed together to
+describe the functionality::
 
     /* The hw ecc generator provides a syndrome instead a ecc value on read
      * This can only work if we have the ecc bytes directly behind the
@@ -881,9 +877,7 @@  describe the functionality.
 ECC selection constants
 -----------------------
 
-Use these constants to select the ECC algorithm.
-
-::
+Use these constants to select the ECC algorithm::
 
     /* No ECC. Usage is not recommended ! */
     #define NAND_ECC_NONE       0
@@ -903,9 +897,7 @@  Hardware control related constants
 ----------------------------------
 
 These constants describe the requested hardware access function when the
-boardspecific hardware control function is called
-
-::
+boardspecific hardware control function is called::
 
     /* Select the chip by setting nCE to low */
     #define NAND_CTL_SETNCE     1
@@ -929,9 +921,7 @@  Bad block table related constants
 ---------------------------------
 
 These constants describe the options used for bad block table
-descriptors.
-
-::
+descriptors::
 
     /* Options for the bad block table descriptors */