From patchwork Fri Apr 14 14:52:09 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mark Wielaard X-Patchwork-Id: 67741 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 63A113858C1F for ; Fri, 14 Apr 2023 14:52:47 +0000 (GMT) X-Original-To: libabigail@sourceware.org Delivered-To: libabigail@sourceware.org Received: from gnu.wildebeest.org (gnu.wildebeest.org [45.83.234.184]) by sourceware.org (Postfix) with ESMTPS id EE9EC3858D20 for ; Fri, 14 Apr 2023 14:52:40 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org EE9EC3858D20 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=klomp.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=klomp.org Received: from r6.localdomain (82-217-174-174.cable.dynamic.v4.ziggo.nl [82.217.174.174]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gnu.wildebeest.org (Postfix) with ESMTPSA id 68A5E302BB02; Fri, 14 Apr 2023 16:52:39 +0200 (CEST) Received: by r6.localdomain (Postfix, from userid 1000) id D748F3402D8; Fri, 14 Apr 2023 16:52:36 +0200 (CEST) From: "Mark J. Wielaard" To: libabigail@sourceware.org Cc: Mark Wielaard Subject: [PATCH] doc: Fix some typos and add some missing references Date: Fri, 14 Apr 2023 16:52:09 +0200 Message-Id: <20230414145209.970092-1-mark@klomp.org> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-Spam-Status: No, score=-3035.3 required=5.0 tests=BAYES_00, GIT_PATCH_0, JMQ_SPF_NEUTRAL, KAM_DMARC_STATUS, RCVD_IN_BARRACUDACENTRAL, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: libabigail@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list of the Libabigail project List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , Errors-To: libabigail-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libabigail" From: Mark Wielaard 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 --- 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.