From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 7850) id 509D53858D28; Tue, 24 Jan 2023 18:18:38 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 509D53858D28 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1674584318; bh=7ze85R9Z5nF+ssOWmL1iO/7TpiPiDhSffvtbnE/Hl0Y=; h=From:To:Subject:Date:From; b=D+txfAxHby9wn1Iut0Q61ZTkJC0ThbCPYFqn9uIgzOGK4zVSVOcb8VFNLFoJqd6Hw ZsD2f8TB2nEhixj6y7RMB0WVIfnyu41gTn41PGgL0/iUwXmC25M3U/0jz4wfWvCBWx nblZpXplAxZ20Q9RvsWTVYDemfii5N/To4ZcURpc= Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Indu Bhagat To: bfd-cvs@sourceware.org, gdb-cvs@sourceware.org Subject: [binutils-gdb] libsframe/doc: fix some warnings X-Act-Checkin: binutils-gdb X-Git-Author: Indu Bhagat X-Git-Refname: refs/heads/master X-Git-Oldrev: f3d8ae90b23695d86ebf894a4a6b95846007fafd X-Git-Newrev: 436bcab71269514af77e689af678022686f0f778 Message-Id: <20230124181838.509D53858D28@sourceware.org> Date: Tue, 24 Jan 2023 18:18:38 +0000 (GMT) List-Id: https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3D436bcab71269= 514af77e689af678022686f0f778 commit 436bcab71269514af77e689af678022686f0f778 Author: Indu Bhagat Date: Tue Jan 24 10:07:13 2023 -0800 libsframe/doc: fix some warnings =20 'make pdf' in libsframe shows some warnings, some of which (especially the Overfull warnings) are causing undesirable effects on the rendered output. Few examples of the warnings: =20 Underfull \hbox (badness 10000) in paragraph at lines 406--407 @texttt pauth_ =20 Underfull \hbox (badness 10000) in paragraph at lines 407--410 @textrm Specify which key is used for signing the return =20 ... =20 Overfull \hbox (2.0987pt too wide) in paragraph at lines 412--413 @texttt fdetype[]| =20 ... =20 Overfull \hbox (28.87212pt too wide) in paragraph at lines 446--447 @textrm SFRAME[]FDE[]TYPE[]PCMASK| =20 ... =20 This patch adjusts column widths of the affected cells to fix a subset of these warnings. For the rest of the warnings, use explicit newline command to fix them. =20 libsframe/ * doc/sframe-spec.texi: Fix various underfull and overfull warnings. Diff: --- libsframe/doc/sframe-spec.texi | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi index 7b647c1a98f..175c622f85d 100644 --- a/libsframe/doc/sframe-spec.texi +++ b/libsframe/doc/sframe-spec.texi @@ -243,7 +243,7 @@ must be the end of the auxilliary SFrame header, if the= latter is present. =20 Tieing it all together: =20 -@multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The ABI/arch= identifier. See above} +@multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The number o= f SFrame FREs in the section.} @headitem Offset @tab Name @tab Description @item 0x00 @tab @code{sframe_preamble sfh_preamble} @@ -396,7 +396,7 @@ used for the function. =20 The info word is a bitfield split into three parts. From MSB to LSB: =20 -@multitable {Bit offset} {@code{isroot}} {Length of variable-length data f= or this type (some kinds only).} +@multitable {Bit offset} {@code{pauth_key}} {Specify which key is used for= signing the return addresses} @headitem Bit offset @tab Name @tab Description @item 7--6 @tab @code{unused} @@ -405,12 +405,16 @@ The info word is a bitfield split into three parts. = >From MSB to LSB: @item 5 @tab @code{pauth_key} @tab Specify which key is used for signing the return addresses in the SFr= ame -FDE. Two possible values: SFRAME_AARCH64_PAUTH_KEY_A (0) or +FDE. Two possible values: @* +SFRAME_AARCH64_PAUTH_KEY_A (0), or @* SFRAME_AARCH64_PAUTH_KEY_B (1). =20 @item 4 @tab @code{fdetype} -@tab SFRAME_FDE_TYPE_PCMASK (1) or SFRAME_FDE_TYPE_PCINC (0). @xref{The SF= rame FDE types}. +@tab Specify the SFrame FDE type. Two possible values: @* +SFRAME_FDE_TYPE_PCMASK (1), or @* +SFRAME_FDE_TYPE_PCINC (0). @* +@xref{The SFrame FDE types}. =20 @item 0--3 @tab @code{fretype} @@ -437,14 +441,16 @@ useful for the cases where a small pattern of instruc= tions in a program stub is used repeatedly for a specific functionality. Typical usecases are pltN entries and trampolines. =20 -@multitable {Name of SFrame FDE type} {Value} {Unwinders perform a (PC >= =3D FRE_START_ADDR)} +@multitable {SFRAME_FDE_TYPE_PCMASK} {Value} {Unwinders perform a Unwinder= s perform a} @headitem Name of SFrame FDE type @tab Value @tab Description =20 @item SFRAME_FDE_TYPE_PCINC -@tab 0 @tab Unwinders perform a (PC >=3D FRE_START_ADDR) to look up a matc= hing FRE. +@tab 0 @tab Unwinders perform a @* +(PC >=3D FRE_START_ADDR) to look up a matching FRE. =20 @item SFRAME_FDE_TYPE_PCMASK -@tab 1 @tab Unwinders perform a (PC & FRE_START_ADDR_AS_MASK >=3D FRE_STA= RT_ADDR_AS_MASK) +@tab 1 @tab Unwinders perform a @* +(PC & FRE_START_ADDR_AS_MASK >=3D FRE_START_ADDR_AS_MASK) to look up a matching FRE. =20 @end multitable @@ -577,8 +583,10 @@ The SFrame FRE info word is a bitfield split into four= parts. From MSB to LSB: =20 @item 5-6 @tab @code{fre_offset_size} -@tab Size of stack offsets in bytes. Valid values are SFRAME_FRE_OFFSET_1= B, -SFRAME_FRE_OFFSET_2B, and SFRAME_FRE_OFFSET_4B. +@tab Size of stack offsets in bytes. Valid values are: @* +SFRAME_FRE_OFFSET_1B, @* +SFRAME_FRE_OFFSET_2B, and @* +SFRAME_FRE_OFFSET_4B. =20 @item 1-4 @tab @code{fre_offset_count}