diff mbox series

doc: Fix some typos and add some missing references

Message ID 20230414145209.970092-1-mark@klomp.org
State New
Headers
Series doc: Fix some typos and add some missing references |

Commit Message

Mark Wielaard April 14, 2023, 2:52 p.m. UTC 
  From: Mark Wielaard <mark@klomp.org>

Building the docs point out a few issues:

abidiff.rst:238: WARNING: Unknown target name: "linux kernel".
abidiff.rst:249: WARNING: Unknown target name: "linux kernel".
abidiff.rst:263: WARNING: Unknown target name: "linux kernel".
abidiff.rst:274: WARNING: Unknown target name: "linux kernel".
abidw.rst:23: WARNING: Unknown target name: "btf`_formats, if present. finally, if no debug info in these formats is found, it only considers `elf".
abidw.rst:34: WARNING: duplicate label abidiff_invocation_label, other instance in doc/manuals/abidiff.rst
abipkgdiff.rst:298: WARNING: Unknown target name: "linux kernel".
abipkgdiff.rst:309: WARNING: Unknown target name: "linux kernel".
abipkgdiff.rst:323: WARNING: Unknown target name: "linux kernel".
abipkgdiff.rst:334: WARNING: Unknown target name: "linux kernel".
libabigail-concepts.rst:620: WARNING: Block quote ends without a blank line; unexpected unindent.
libabigail-overview.rst:1: WARNING: Title overline too short.

Fix those as follows:

    * doc/manuals/abidiff.rst: Add Linux Kernel reference.
    * doc/manuals/abipkgdiff.rst: Likewise.
    * doc/manuals/abidw.rst: Add space between `BTF`_ and formats.
    Rename _abidiff_invocation_label to _abidw_invocation_label.
    * doc/manuals/libabigail-concepts.rst: Add empty line between
    _suppr_has_size_change_property_label and has_size_change.
    * doc/manuals/libabigail-overview.rst: Extend title overlines.

Signed-off-by: Mark Wielaard <mark@klomp.org>
---
 doc/manuals/abidiff.rst             | 1 +
 doc/manuals/abidw.rst               | 4 ++--
 doc/manuals/abipkgdiff.rst          | 1 +
 doc/manuals/libabigail-concepts.rst | 1 +
 doc/manuals/libabigail-overview.rst | 4 ++--
 5 files changed, 7 insertions(+), 4 deletions(-)

Comments

Dodji Seketeli April 21, 2023, 5:34 p.m. UTC | #1 
"Mark J. Wielaard" <mark@klomp.org> a écrit:

> From: Mark Wielaard <mark@klomp.org>
>
> Building the docs point out a few issues:
>
> abidiff.rst:238: WARNING: Unknown target name: "linux kernel".
> abidiff.rst:249: WARNING: Unknown target name: "linux kernel".
> abidiff.rst:263: WARNING: Unknown target name: "linux kernel".
> abidiff.rst:274: WARNING: Unknown target name: "linux kernel".
> abidw.rst:23: WARNING: Unknown target name: "btf`_formats, if present. finally, if no debug info in these formats is found, it only considers `elf".
> abidw.rst:34: WARNING: duplicate label abidiff_invocation_label, other instance in doc/manuals/abidiff.rst
> abipkgdiff.rst:298: WARNING: Unknown target name: "linux kernel".
> abipkgdiff.rst:309: WARNING: Unknown target name: "linux kernel".
> abipkgdiff.rst:323: WARNING: Unknown target name: "linux kernel".
> abipkgdiff.rst:334: WARNING: Unknown target name: "linux kernel".
> libabigail-concepts.rst:620: WARNING: Block quote ends without a blank line; unexpected unindent.
> libabigail-overview.rst:1: WARNING: Title overline too short.
>
> Fix those as follows:
>
>     * doc/manuals/abidiff.rst: Add Linux Kernel reference.
>     * doc/manuals/abipkgdiff.rst: Likewise.
>     * doc/manuals/abidw.rst: Add space between `BTF`_ and formats.
>     Rename _abidiff_invocation_label to _abidw_invocation_label.
>     * doc/manuals/libabigail-concepts.rst: Add empty line between
>     _suppr_has_size_change_property_label and has_size_change.
>     * doc/manuals/libabigail-overview.rst: Extend title overlines.
>
> Signed-off-by: Mark Wielaard <mark@klomp.org>

Applied to master, thanks!

[...]

Cheers,
diff mbox series

Patch

diff --git a/doc/manuals/abidiff.rst b/doc/manuals/abidiff.rst
index d5dc9699..0c965c41 100644
--- a/doc/manuals/abidiff.rst
+++ b/doc/manuals/abidiff.rst
@@ -852,3 +852,4 @@  Usage examples
 .. _ODR: https://en.wikipedia.org/wiki/One_Definition_Rule
 .. _One Definition Rule: https://en.wikipedia.org/wiki/One_Definition_Rule
 .. _DWZ: https://sourceware.org/dwz
+.. _Linux Kernel: https://kernel.org/
diff --git a/doc/manuals/abidw.rst b/doc/manuals/abidw.rst
index 93eced71..3cba434c 100644
--- a/doc/manuals/abidw.rst
+++ b/doc/manuals/abidw.rst
@@ -22,13 +22,13 @@  types.
 
 To generate either ABI or KMI representation, by default ``abidw``
 uses debug information in the `DWARF`_ format, if present, otherwise
-it looks for debug information in `CTF`_ or `BTF`_formats, if present.
+it looks for debug information in `CTF`_ or `BTF`_ formats, if present.
 Finally, if no debug info in these formats is found, it only considers
 `ELF`_ symbols and report about their addition or removal.
 
 .. include:: tools-use-libabigail.txt
 
-.. _abidiff_invocation_label:
+.. _abidw_invocation_label:
 
 Invocation
 ==========
diff --git a/doc/manuals/abipkgdiff.rst b/doc/manuals/abipkgdiff.rst
index d448ad3e..5f499ae1 100644
--- a/doc/manuals/abipkgdiff.rst
+++ b/doc/manuals/abipkgdiff.rst
@@ -583,3 +583,4 @@  In the later case, the value of the exit code is the same as for the
 .. _ODR: https://en.wikipedia.org/wiki/One_Definition_Rule
 .. _One Definition Rule: https://en.wikipedia.org/wiki/One_Definition_Rule
 .. _DWZ: https://sourceware.org/dwz
+.. _Linux Kernel: https://kernel.org/
diff --git a/doc/manuals/libabigail-concepts.rst b/doc/manuals/libabigail-concepts.rst
index 326a346e..4f26932c 100644
--- a/doc/manuals/libabigail-concepts.rst
+++ b/doc/manuals/libabigail-concepts.rst
@@ -617,6 +617,7 @@  names start with the string "private_data_member".
 
 
  .. _suppr_has_size_change_property_label:
+
 * ``has_size_change``
 
  Usage:
diff --git a/doc/manuals/libabigail-overview.rst b/doc/manuals/libabigail-overview.rst
index 88832ab3..73f4e1f7 100644
--- a/doc/manuals/libabigail-overview.rst
+++ b/doc/manuals/libabigail-overview.rst
@@ -1,6 +1,6 @@ 
-####################
+#################################
 Overview of the Abigail framework
-####################
+#################################
 
 **ABIGAIL** stands for the Application Binary Interface Generic
 Analysis and Instrumentation Library.