From: "Mark J. Wielaard" <mark@klomp.org>
To: libabigail@sourceware.org
Cc: Mark Wielaard <mark@klomp.org>
Subject: [PATCH] doc: Fix some typos and add some missing references
Date: Fri, 14 Apr 2023 16:52:09 +0200 [thread overview]
Message-ID: <20230414145209.970092-1-mark@klomp.org> (raw)
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(-)
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.
--
2.39.2
next reply other threads:[~2023-04-14 14:52 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-14 14:52 Mark J. Wielaard [this message]
2023-04-21 17:34 ` Dodji Seketeli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230414145209.970092-1-mark@klomp.org \
--to=mark@klomp.org \
--cc=libabigail@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).