lkml.org 
[lkml]   [2019]   [Mar]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH 6/9] docs: Use correct list markup character
From
Date
On 3/7/19 1:11 PM, Tobin C. Harding wrote:
> Sphinx uses a star not a hyphen for lists.
>
> Use correct list markup character.
>
> Signed-off-by: Tobin C. Harding <tobin@kernel.org>

Hi Tobin,

The blank line insertions are all that is needed.
And I have already sent a patch for that.

Also, a list can begin with any of:
"A text block which begins with a "*", "+", "-", "•", "‣", or "⁃", followed by whitespace, is a bullet list item (a.k.a. "unordered" list item)."

from http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists


> ---
> Documentation/driver-api/gpio/board.rst | 5 +++--
> Documentation/laptops/lg-laptop.rst | 12 ++++++------
> 2 files changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/driver-api/gpio/board.rst b/Documentation/driver-api/gpio/board.rst
> index a0f294e2e250..a5d5c22ab610 100644
> --- a/Documentation/driver-api/gpio/board.rst
> +++ b/Documentation/driver-api/gpio/board.rst
> @@ -204,8 +204,9 @@ between a caller and a respective .get/set_multiple() callback of a GPIO chip.
>
> In order to qualify for fast bitmap processing, the array must meet the
> following requirements:
> -- pin hardware number of array member 0 must also be 0,
> -- pin hardware numbers of consecutive array members which belong to the same
> +
> +* pin hardware number of array member 0 must also be 0.
> +* pin hardware numbers of consecutive array members which belong to the same
> chip as member 0 does must also match their array indexes.
>
> Otherwise fast bitmap processing path is not used in order to avoid consecutive
> diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
> index e486fe7ddc35..d9e560dfd045 100644
> --- a/Documentation/laptops/lg-laptop.rst
> +++ b/Documentation/laptops/lg-laptop.rst
> @@ -9,12 +9,12 @@ Hotkeys
> -------
>
> The following FN keys are ignored by the kernel without this driver:
> -- FN-F1 (LG control panel) - Generates F15
> -- FN-F5 (Touchpad toggle) - Generates F13
> -- FN-F6 (Airplane mode) - Generates RFKILL
> -- FN-F8 (Keyboard backlight) - Generates F16.
> - This key also changes keyboard backlight mode.
> -- FN-F9 (Reader mode) - Generates F14
> +
> +* FN-F1 (LG control panel) - Generates F15
> +* FN-F5 (Touchpad toggle) - Generates F13
> +* FN-F6 (Airplane mode) - Generates RFKILL
> +* FN-F8 (Keyboard backlight) - Generates F16 (This key also changes keyboard backlight mode)
> +* FN-F9 (Reader mode) - Generates F14
>
> The rest of the FN key work without a need for a special driver.
>
>


--
~Randy

\
 
 \ /
  Last update: 2019-03-08 04:41    [W:1.237 / U:0.376 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site