From patchwork Wed Aug 30 16:26:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 74986 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 7C62B3858C39 for ; Wed, 30 Aug 2023 16:29:11 +0000 (GMT) X-Original-To: binutils@sourceware.org Delivered-To: binutils@sourceware.org Received: from omta33.uswest2.a.cloudfilter.net (omta33.uswest2.a.cloudfilter.net [35.89.44.32]) by sourceware.org (Postfix) with ESMTPS id AC1C63858D35 for ; Wed, 30 Aug 2023 16:28:46 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org AC1C63858D35 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=tromey.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=tromey.com Received: from eig-obgw-5008a.ext.cloudfilter.net ([10.0.29.246]) by cmsmtp with ESMTP id bFOsqt3lfOzKlbO3gq8Psr; Wed, 30 Aug 2023 16:28:45 +0000 Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with ESMTPS id bO3fqAnPE7derbO3gq0oRF; Wed, 30 Aug 2023 16:28:44 +0000 X-Authority-Analysis: v=2.4 cv=UcJC9YeN c=1 sm=1 tr=0 ts=64ef6e3c a=ApxJNpeYhEAb1aAlGBBbmA==:117 a=ApxJNpeYhEAb1aAlGBBbmA==:17 a=OWjo9vPv0XrRhIrVQ50Ab3nP57M=:19 a=dLZJa+xiwSxG16/P+YVxDGlgEgI=:19 a=UttIx32zK-AA:10 a=Qbun_eYptAEA:10 a=CCpqsmhAAAAA:8 a=zstS-IiYAAAA:8 a=TkTTPzHaAAAA:8 a=NEAV23lmAAAA:8 a=3TfLQeZ31Am4LcUOb6wA:9 a=ul9cdbp4aOFLsgKbc677:22 a=4G6NA9xxw8l3yy4pmD5M:22 a=Qz3p68GZ3z-NqTySStDO:22 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To: Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=fLgke3Th+hx1dUZMvs0HbEQ9DkMKcjOttNIisCR9drY=; b=foJU+Z+o9ZcucHPgkW+Xrk/g60 rAzI4+17TYchr/kCC9fvfYL3q9tVjO4qQLeLb+59CZrno4CdFymhjl67Te+Wtgx7rd7Mrv3YaAJQt vDQaWDI6uuzYWawnijZof23UI; Received: from 75-166-150-212.hlrn.qwest.net ([75.166.150.212]:46822 helo=localhost.localdomain) by box5379.bluehost.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1qbO3f-001fMG-18; Wed, 30 Aug 2023 10:28:43 -0600 From: Tom Tromey To: binutils@sourceware.org Subject: [RFC 1/2] Revert "Simplify @node use in BFD documentation" Date: Wed, 30 Aug 2023 10:26:32 -0600 Message-ID: <20230830162836.2257576-2-tom@tromey.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230830162836.2257576-1-tom@tromey.com> References: <20230830162836.2257576-1-tom@tromey.com> MIME-Version: 1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - box5379.bluehost.com X-AntiAbuse: Original Domain - sourceware.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - tromey.com X-BWhitelist: no X-Source-IP: 75.166.150.212 X-Source-L: No X-Exim-ID: 1qbO3f-001fMG-18 X-Source: X-Source-Args: X-Source-Dir: X-Source-Sender: 75-166-150-212.hlrn.qwest.net (localhost.localdomain) [75.166.150.212]:46822 X-Source-Auth: tom+tromey.com X-Email-Count: 4 X-Org: HG=bhshared;ORG=bluehost; X-Source-Cap: ZWx5bnJvYmk7ZWx5bnJvYmk7Ym94NTM3OS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-CMAE-Envelope: MS4xfM19PL3eqWJo9/cqTVlm0p6DKyldk4DnJBuZr+5ve14G1pvHYMntc/vvqq0mvAABzgOY40oIekQMEUER2/14od/76pNv2s8tIJ+b6tfwKuPxZ5F2gitN NGKW4jCgaSEegNA7xIo0JNkNAJ41POWaFHdk51aUufzFaUIj/bY78YeyImfDWRelVS9LWHAamTdMiQ3tER+l2ZSV5O5OOWloMkE= X-Spam-Status: No, score=-3025.5 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, GIT_PATCH_0, JMQ_SPF_NEUTRAL, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_PASS, TXREP 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: binutils@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Binutils mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tom Tromey Errors-To: binutils-bounces+patchwork=sourceware.org@sourceware.org Sender: "Binutils" This reverts commit 8bb23cdbb498ff645bb0937bc8c0cb89e9e5ebd8. My earlier patch to simplifify the @node uses in the BFD manual didn't take into account (1) that BFD doesn't use the ordinary texinfo sectioning commands, and (2) that some users are stuck on very ancient versions of makeinfo. This patch reverts the change. I went through the entire manual using the spacebar, trying to find the original problem I reported in the change, but couldn't. I don't know why. Anyway, all this means is that, with this reversion, editing the node structure will be slightly less convenient. Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=30703 bfd/ChangeLog 2023-08-30 Tom Tromey PR binutils/30703 * doc/webassembly.texi, doc/bfd.texi: Revert 8bb23cdb, adding parameters back to @node. --- bfd/ChangeLog | 6 +++++ bfd/doc/bfd.texi | 56 ++++++++++++++++++++-------------------- bfd/doc/webassembly.texi | 2 +- 3 files changed, 35 insertions(+), 29 deletions(-) diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi index d8cc1ecca48..f348710845f 100644 --- a/bfd/doc/bfd.texi +++ b/bfd/doc/bfd.texi @@ -75,7 +75,7 @@ Copyright @copyright{} 1991-2023 Free Software Foundation, Inc. @end iftex @contents -@node Top +@node Top, Overview, (dir), (dir) @ifinfo This file documents the binary file descriptor library libbfd. @end ifinfo @@ -88,7 +88,7 @@ This file documents the binary file descriptor library libbfd. * BFD Index:: BFD Index @end menu -@node Overview +@node Overview, BFD front end, Top, Top @chapter Introduction @cindex BFD @cindex what is it? @@ -114,7 +114,7 @@ their own use, for greater efficiency. * What BFD Version 2 Can Do:: What BFD Version 2 Can Do @end menu -@node History +@node History, How It Works, Overview, Overview @section History One spur behind BFD was the desire, on the part of the GNU 960 team at @@ -137,7 +137,7 @@ and David Henkel-Wallace (@code{gumby@@cygnus.com}). -@node How It Works +@node How It Works, What BFD Version 2 Can Do, History, Overview @section How To Use BFD To use the library, include @file{bfd.h} and link with @file{libbfd.a}. @@ -188,11 +188,11 @@ and contain subordinate BFDs. This approach is fine for a.out and coff, but loses efficiency when applied to formats such as S-records and IEEE-695. -@node What BFD Version 2 Can Do +@node What BFD Version 2 Can Do, , How It Works, Overview @section What BFD Version 2 Can Do @include bfdsumm.texi -@node BFD front end +@node BFD front end, BFD back ends, Overview, Top @chapter BFD Front End @menu @@ -219,7 +219,7 @@ IEEE-695. @include bfdt.texi @include bfdio.texi -@node Memory Usage +@node Memory Usage, Sections, Miscellaneous, BFD front end @section Memory Usage BFD keeps all of its internal structures in obstacks. There is one obstack per open BFD file, into which the current state is stored. When a BFD is @@ -242,46 +242,46 @@ select the greediest open BFD, close it to reclaim the memory, perform some operation and reopen the BFD again, to get a fresh copy of the data structures. -@node Sections +@node Sections, Symbols, Memory Usage, BFD front end @include section.texi -@node Symbols +@node Symbols, Archives, Sections, BFD front end @include syms.texi -@node Archives +@node Archives, Formats, Symbols, BFD front end @include archive.texi -@node Formats +@node Formats, Relocations, Archives, BFD front end @include format.texi -@node Relocations +@node Relocations, Core Files, Formats, BFD front end @include reloc.texi -@node Core Files +@node Core Files, Targets, Relocations, BFD front end @include corefile.texi -@node Targets +@node Targets, Architectures, Core Files, BFD front end @include targets.texi -@node Architectures +@node Architectures, Opening and Closing, Targets, BFD front end @include archures.texi -@node Opening and Closing +@node Opening and Closing, Internal, Architectures, BFD front end @include opncls.texi -@node Internal +@node Internal, File Caching, Opening and Closing, BFD front end @include libbfd.texi -@node File Caching +@node File Caching, Linker Functions, Internal, BFD front end @include cache.texi -@node Linker Functions +@node Linker Functions, Hash Tables, File Caching, BFD front end @include linker.texi -@node Hash Tables +@node Hash Tables, , Linker Functions, BFD front end @include hash.texi -@node BFD back ends +@node BFD back ends, GNU Free Documentation License, BFD front end, Top @chapter BFD back ends @menu * What to Put Where:: @@ -293,28 +293,28 @@ structures. * srecord :: s-record backend @end ignore @end menu -@node What to Put Where +@node What to Put Where, aout, BFD back ends, BFD back ends @section What to Put Where All of BFD lives in one directory. -@node aout +@node aout, coff, What to Put Where, BFD back ends @include aoutx.texi -@node coff +@node coff, elf, aout, BFD back ends @include coffcode.texi -@node elf +@node elf, mmo, coff, BFD back ends @include elf.texi @c Leave this out until the file has some actual contents... @c @include elfcode.texi -@node mmo +@node mmo, , elf, BFD back ends @include mmo.texi -@node GNU Free Documentation License +@node GNU Free Documentation License, BFD Index, BFD back ends, Top @include fdl.texi -@node BFD Index +@node BFD Index, , GNU Free Documentation License, Top @unnumbered BFD Index @printindex cp diff --git a/bfd/doc/webassembly.texi b/bfd/doc/webassembly.texi index 5a05199d5f7..ad650943a1a 100644 --- a/bfd/doc/webassembly.texi +++ b/bfd/doc/webassembly.texi @@ -27,7 +27,7 @@ in some malformed WebAssembly modules being treated as valid. * File layout:: @end menu -@node File layout +@node File layout, WebAssembly @subsection File layout For a description of the WebAssembly file format, see @url{https://github.com/WebAssembly/design/blob/master/BinaryEncoding.md}. From patchwork Wed Aug 30 16:26:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 74985 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 C5BD3385C303 for ; Wed, 30 Aug 2023 16:29:07 +0000 (GMT) X-Original-To: binutils@sourceware.org Delivered-To: binutils@sourceware.org Received: from omta037.useast.a.cloudfilter.net (omta037.useast.a.cloudfilter.net [44.202.169.36]) by sourceware.org (Postfix) with ESMTPS id 679413858D28 for ; Wed, 30 Aug 2023 16:28:45 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 679413858D28 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=tromey.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=tromey.com Received: from eig-obgw-5002a.ext.cloudfilter.net ([10.0.29.215]) by cmsmtp with ESMTP id bMvzq6XNDWU1cbO3hqJrxb; Wed, 30 Aug 2023 16:28:45 +0000 Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with ESMTPS id bO3fqM9efdh4DbO3gqagxq; Wed, 30 Aug 2023 16:28:44 +0000 X-Authority-Analysis: v=2.4 cv=Zu7+lv3G c=1 sm=1 tr=0 ts=64ef6e3c a=ApxJNpeYhEAb1aAlGBBbmA==:117 a=ApxJNpeYhEAb1aAlGBBbmA==:17 a=OWjo9vPv0XrRhIrVQ50Ab3nP57M=:19 a=dLZJa+xiwSxG16/P+YVxDGlgEgI=:19 a=UttIx32zK-AA:10 a=Qbun_eYptAEA:10 a=zstS-IiYAAAA:8 a=AI3NeJD76etOeGQATzsA:9 a=4G6NA9xxw8l3yy4pmD5M:22 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To: Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=7KHzuStnojyyjAHZOXrOOj2I40llxd4d/EW7HBPEo3k=; b=u4VhNRpni1/BHTBlepr/yRj/lk 49spc/8HT0qp1OSs4X0oV6FaMPYd9l4FD8qvPauUee/cTtimIaILhQkWDaFTIp3tV0g/JF5r1OboS tn2IdtWx/pP3bkxHW3cYG8E97; Received: from 75-166-150-212.hlrn.qwest.net ([75.166.150.212]:46822 helo=localhost.localdomain) by box5379.bluehost.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1qbO3f-001fMG-1t; Wed, 30 Aug 2023 10:28:43 -0600 From: Tom Tromey To: binutils@sourceware.org Subject: [RFC 2/2] Remove libbfd.texi Date: Wed, 30 Aug 2023 10:26:33 -0600 Message-ID: <20230830162836.2257576-3-tom@tromey.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230830162836.2257576-1-tom@tromey.com> References: <20230830162836.2257576-1-tom@tromey.com> MIME-Version: 1.0 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - box5379.bluehost.com X-AntiAbuse: Original Domain - sourceware.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - tromey.com X-BWhitelist: no X-Source-IP: 75.166.150.212 X-Source-L: No X-Exim-ID: 1qbO3f-001fMG-1t X-Source: X-Source-Args: X-Source-Dir: X-Source-Sender: 75-166-150-212.hlrn.qwest.net (localhost.localdomain) [75.166.150.212]:46822 X-Source-Auth: tom+tromey.com X-Email-Count: 6 X-Org: HG=bhshared;ORG=bluehost; X-Source-Cap: ZWx5bnJvYmk7ZWx5bnJvYmk7Ym94NTM3OS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-CMAE-Envelope: MS4xfBrNFuzF3mufG4rha25WyRV6YAVvA1NkKCbGe70MD4SWYk0t3hMd0R8gRlg9aieOOxKk/TXlDOlbY37j2BFSAZAoCA2+Myz/IPK2QMI6p2Nia3lEmfCC H7iZ3ZEq/11KdwWJn4liNEoSFOJLVfb3Mx8A2/y/GIRgIfmrPr1CVSeRx2yAlpnkwT63r6i1lbPeWoeyCqvd6sDlNJZ5I8mPN3E= X-Spam-Status: No, score=-3025.1 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, GIT_PATCH_0, JMQ_SPF_NEUTRAL, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_PASS, TXREP 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: binutils@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Binutils mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Tom Tromey Errors-To: binutils-bounces+patchwork=sourceware.org@sourceware.org Sender: "Binutils" While paging through the BFD manual, I noticed that the "Internals" node is completely empty. This patch removes it. bfd/ChangeLog 2023-08-30 Tom Tromey * doc/local.mk (DOCFILES): Remove libbfd.texi. * Makefile.in: Regenerate. * doc/bfd.texi (Internal): Remove node. --- bfd/ChangeLog | 6 ++++++ bfd/Makefile.in | 1 - bfd/doc/bfd.texi | 8 ++------ bfd/doc/local.mk | 1 - 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/bfd/Makefile.in b/bfd/Makefile.in index bb530271fca..20333403e38 100644 --- a/bfd/Makefile.in +++ b/bfd/Makefile.in @@ -1251,7 +1251,6 @@ DOCFILES = \ doc/elf.texi \ doc/format.texi \ doc/hash.texi \ - doc/libbfd.texi \ doc/linker.texi \ doc/mmo.texi \ doc/opncls.texi \ diff --git a/bfd/doc/bfd.texi b/bfd/doc/bfd.texi index f348710845f..07b688e31ff 100644 --- a/bfd/doc/bfd.texi +++ b/bfd/doc/bfd.texi @@ -210,7 +210,6 @@ IEEE-695. * Targets:: * Architectures:: * Opening and Closing:: -* Internal:: * File Caching:: * Linker Functions:: * Hash Tables:: @@ -266,13 +265,10 @@ structures. @node Architectures, Opening and Closing, Targets, BFD front end @include archures.texi -@node Opening and Closing, Internal, Architectures, BFD front end +@node Opening and Closing, File Caching, Architectures, BFD front end @include opncls.texi -@node Internal, File Caching, Opening and Closing, BFD front end -@include libbfd.texi - -@node File Caching, Linker Functions, Internal, BFD front end +@node File Caching, Linker Functions, Opening and Closing, BFD front end @include cache.texi @node Linker Functions, Hash Tables, File Caching, BFD front end diff --git a/bfd/doc/local.mk b/bfd/doc/local.mk index d80f70416a3..d81347d049c 100644 --- a/bfd/doc/local.mk +++ b/bfd/doc/local.mk @@ -32,7 +32,6 @@ DOCFILES = \ %D%/elf.texi \ %D%/format.texi \ %D%/hash.texi \ - %D%/libbfd.texi \ %D%/linker.texi \ %D%/mmo.texi \ %D%/opncls.texi \