diff mbox series

[2/3] docs: firmware-guide: acpi: dsd: graph.rst: replace some characters

Message ID a65b04a5cf341cff02d4b514dd4889b4fa4f94b8.1626947264.git.mchehab+huawei@kernel.org
State Accepted
Commit dc9c31c3ffc803b5362ca9d6ff1426ccb738f77e
Headers show
Series None | expand

Commit Message

Mauro Carvalho Chehab July 22, 2021, 9:50 a.m. UTC
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.

Replace the occurences of the following characters:

	- U+00a0 (' '): NO-BREAK SPACE
	  as it can cause lines being truncated on PDF output

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Sakari Ailus July 26, 2021, noon UTC | #1
Hi Mauro,

On Thu, Jul 22, 2021 at 11:50:02AM +0200, Mauro Carvalho Chehab wrote:
> The conversion tools used during DocBook/LaTeX/html/Markdown->ReST

> conversion and some cut-and-pasted text contain some characters that

> aren't easily reachable on standard keyboards and/or could cause

> troubles when parsed by the documentation build system.

> 

> Replace the occurences of the following characters:

> 

> 	- U+00a0 (' '): NO-BREAK SPACE

> 	  as it can cause lines being truncated on PDF output

> 

> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst

> index 4341299aa937..0ced07cb1be3 100644

> --- a/Documentation/firmware-guide/acpi/dsd/graph.rst

> +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst

> @@ -159,7 +159,7 @@ References

>  

>  [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03.

>  

> -[3] Documentation/devicetree/bindings/graph.txt

> +[3] Documentation/devicetree/bindings/graph.txt


I probably wrote this as a non-break space is produced by space + mod5,
preceded by opening bracket which also requires mod5.

The file is there but the file has moved to DT schema repository. I believe
the correct reference is:

https://github.com/devicetree-org/dt-schema/blob/master/schemas/graph.yaml

>  

>  [4] Device Properties UUID For _DSD.

>      https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,


-- 
Kind regards,

Sakari Ailus
diff mbox series

Patch

diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
index 4341299aa937..0ced07cb1be3 100644
--- a/Documentation/firmware-guide/acpi/dsd/graph.rst
+++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
@@ -159,7 +159,7 @@  References
 
 [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03.
 
-[3] Documentation/devicetree/bindings/graph.txt
+[3] Documentation/devicetree/bindings/graph.txt
 
 [4] Device Properties UUID For _DSD.
     https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,