From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from qproxy1-pub.mail.unifiedlayer.com (qproxy1-pub.mail.unifiedlayer.com [173.254.64.10]) by sourceware.org (Postfix) with ESMTPS id 31C9D3896C06 for ; Wed, 8 Feb 2023 07:18:46 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 31C9D3896C06 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 gproxy1-pub.mail.unifiedlayer.com (unknown [69.89.25.95]) by qproxy1.mail.unifiedlayer.com (Postfix) with ESMTP id 68EDF802AFDB for ; Wed, 8 Feb 2023 07:18:44 +0000 (UTC) Received: from cmgw12.mail.unifiedlayer.com (unknown [10.0.90.127]) by progateway3.mail.pro1.eigbox.com (Postfix) with ESMTP id DE63D1003F23C for ; Wed, 8 Feb 2023 07:17:43 +0000 (UTC) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with ESMTP id Pei7paH6jP796Pei7pY6iN; Wed, 08 Feb 2023 07:17:43 +0000 X-Authority-Reason: nr=8 X-Authority-Analysis: v=2.4 cv=MJClJOVl c=1 sm=1 tr=0 ts=63e34c97 a=ApxJNpeYhEAb1aAlGBBbmA==:117 a=ApxJNpeYhEAb1aAlGBBbmA==:17 a=dLZJa+xiwSxG16/P+YVxDGlgEgI=:19 a=m04uMKEZRckA:10:nop_rcvd_month_year a=Qbun_eYptAEA:10:endurance_base64_authed_username_1 a=zstS-IiYAAAA:8 a=TkTTPzHaAAAA:8 a=NEAV23lmAAAA:8 a=kRWsFjpTwGv3dUKSflYA:9 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=D/nH77bnG+LMqx5peE0E34cTdKTEzGNG/UB8P8YfHJg=; b=mA7918Ip6TkVhReerbKzE+ZbE+ 2xz4NJCZxZrTASrPHedkViO41lIkU6jSjppDBLDimFJKBhMorpWgOHKwZ3mHkem6SnzSZUmi4lIEW /wklxCkjL8koX5jZ0EXYOF2ti; Received: from 75-166-130-93.hlrn.qwest.net ([75.166.130.93]:55392 helo=localhost.localdomain) by box5379.bluehost.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1pPei7-002znH-Jw; Wed, 08 Feb 2023 00:17:43 -0700 From: Tom Tromey To: binutils@sourceware.org Cc: Tom Tromey Subject: [PATCH 2/8] Simplify @node use in BFD documentation Date: Wed, 8 Feb 2023 00:17:19 -0700 Message-Id: <20230208071725.3668898-3-tom@tromey.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20230208071725.3668898-1-tom@tromey.com> References: <20230208071725.3668898-1-tom@tromey.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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.130.93 X-Source-L: No X-Exim-ID: 1pPei7-002znH-Jw X-Source: X-Source-Args: X-Source-Dir: X-Source-Sender: 75-166-130-93.hlrn.qwest.net (localhost.localdomain) [75.166.130.93]:55392 X-Source-Auth: tom+tromey.com X-Email-Count: 3 X-Source-Cap: ZWx5bnJvYmk7ZWx5bnJvYmk7Ym94NTM3OS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-Spam-Status: No, score=-3028.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,GIT_PATCH_0,JMQ_SPF_NEUTRAL,RCVD_IN_DNSWL_NONE,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 List-Id: The BFD docs currently specify all the parameters to @node. However, this results in bad navigation in certain nodes -- the "space" command in info doesn't know how to find the next node. I think this style of @node is a leftover from ancient times. Makeinfo can figure out the node structure on its own now, so simplify everything to a single-argument @node. 2023-02-07 Tom Tromey * doc/webassembly.texi (File layout): Remove second argument from @node. * doc/bfd.texi: Use single-argument @node everywhere. --- 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 f348710845f..d8cc1ecca48 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, Overview, (dir), (dir) +@node Top @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, BFD front end, Top, Top +@node Overview @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, How It Works, Overview, Overview +@node History @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, What BFD Version 2 Can Do, History, Overview +@node How It Works @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, , How It Works, Overview +@node What BFD Version 2 Can Do @section What BFD Version 2 Can Do @include bfdsumm.texi -@node BFD front end, BFD back ends, Overview, Top +@node BFD front end @chapter BFD Front End @menu @@ -219,7 +219,7 @@ IEEE-695. @include bfdt.texi @include bfdio.texi -@node Memory Usage, Sections, Miscellaneous, BFD front end +@node Memory Usage @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, Symbols, Memory Usage, BFD front end +@node Sections @include section.texi -@node Symbols, Archives, Sections, BFD front end +@node Symbols @include syms.texi -@node Archives, Formats, Symbols, BFD front end +@node Archives @include archive.texi -@node Formats, Relocations, Archives, BFD front end +@node Formats @include format.texi -@node Relocations, Core Files, Formats, BFD front end +@node Relocations @include reloc.texi -@node Core Files, Targets, Relocations, BFD front end +@node Core Files @include corefile.texi -@node Targets, Architectures, Core Files, BFD front end +@node Targets @include targets.texi -@node Architectures, Opening and Closing, Targets, BFD front end +@node Architectures @include archures.texi -@node Opening and Closing, Internal, Architectures, BFD front end +@node Opening and Closing @include opncls.texi -@node Internal, File Caching, Opening and Closing, BFD front end +@node Internal @include libbfd.texi -@node File Caching, Linker Functions, Internal, BFD front end +@node File Caching @include cache.texi -@node Linker Functions, Hash Tables, File Caching, BFD front end +@node Linker Functions @include linker.texi -@node Hash Tables, , Linker Functions, BFD front end +@node Hash Tables @include hash.texi -@node BFD back ends, GNU Free Documentation License, BFD front end, Top +@node BFD back ends @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, aout, BFD back ends, BFD back ends +@node What to Put Where @section What to Put Where All of BFD lives in one directory. -@node aout, coff, What to Put Where, BFD back ends +@node aout @include aoutx.texi -@node coff, elf, aout, BFD back ends +@node coff @include coffcode.texi -@node elf, mmo, coff, BFD back ends +@node elf @include elf.texi @c Leave this out until the file has some actual contents... @c @include elfcode.texi -@node mmo, , elf, BFD back ends +@node mmo @include mmo.texi -@node GNU Free Documentation License, BFD Index, BFD back ends, Top +@node GNU Free Documentation License @include fdl.texi -@node BFD Index, , GNU Free Documentation License, Top +@node BFD Index @unnumbered BFD Index @printindex cp diff --git a/bfd/doc/webassembly.texi b/bfd/doc/webassembly.texi index ad650943a1a..5a05199d5f7 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, WebAssembly +@node File layout @subsection File layout For a description of the WebAssembly file format, see @url{https://github.com/WebAssembly/design/blob/master/BinaryEncoding.md}. -- 2.39.1