Skip to content

Commit 436bcab

Browse files
committed
libsframe/doc: fix some warnings
'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: Underfull \hbox (badness 10000) in paragraph at lines 406--407 @texttt pauth_ Underfull \hbox (badness 10000) in paragraph at lines 407--410 @textrm Specify which key is used for signing the return ... Overfull \hbox (2.0987pt too wide) in paragraph at lines 412--413 @texttt fdetype[]| ... Overfull \hbox (28.87212pt too wide) in paragraph at lines 446--447 @textrm SFRAME[]FDE[]TYPE[]PCMASK| ... 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. libsframe/ * doc/sframe-spec.texi: Fix various underfull and overfull warnings.
1 parent f3d8ae9 commit 436bcab

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

libsframe/doc/sframe-spec.texi

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ must be the end of the auxilliary SFrame header, if the latter is present.
243243

244244
Tieing it all together:
245245

246-
@multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The ABI/arch identifier. See above}
246+
@multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The number of SFrame FREs in the section.}
247247
@headitem Offset @tab Name @tab Description
248248
@item 0x00
249249
@tab @code{sframe_preamble sfh_preamble}
@@ -396,7 +396,7 @@ used for the function.
396396

397397
The info word is a bitfield split into three parts. From MSB to LSB:
398398

399-
@multitable {Bit offset} {@code{isroot}} {Length of variable-length data for this type (some kinds only).}
399+
@multitable {Bit offset} {@code{pauth_key}} {Specify which key is used for signing the return addresses}
400400
@headitem Bit offset @tab Name @tab Description
401401
@item 7--6
402402
@tab @code{unused}
@@ -405,12 +405,16 @@ The info word is a bitfield split into three parts. From MSB to LSB:
405405
@item 5
406406
@tab @code{pauth_key}
407407
@tab Specify which key is used for signing the return addresses in the SFrame
408-
FDE. Two possible values: SFRAME_AARCH64_PAUTH_KEY_A (0) or
408+
FDE. Two possible values: @*
409+
SFRAME_AARCH64_PAUTH_KEY_A (0), or @*
409410
SFRAME_AARCH64_PAUTH_KEY_B (1).
410411

411412
@item 4
412413
@tab @code{fdetype}
413-
@tab SFRAME_FDE_TYPE_PCMASK (1) or SFRAME_FDE_TYPE_PCINC (0). @xref{The SFrame FDE types}.
414+
@tab Specify the SFrame FDE type. Two possible values: @*
415+
SFRAME_FDE_TYPE_PCMASK (1), or @*
416+
SFRAME_FDE_TYPE_PCINC (0). @*
417+
@xref{The SFrame FDE types}.
414418

415419
@item 0--3
416420
@tab @code{fretype}
@@ -437,14 +441,16 @@ useful for the cases where a small pattern of instructions in a program stub is
437441
used repeatedly for a specific functionality. Typical usecases are pltN
438442
entries and trampolines.
439443

440-
@multitable {Name of SFrame FDE type} {Value} {Unwinders perform a (PC >= FRE_START_ADDR)}
444+
@multitable {SFRAME_FDE_TYPE_PCMASK} {Value} {Unwinders perform a Unwinders perform a}
441445
@headitem Name of SFrame FDE type @tab Value @tab Description
442446

443447
@item SFRAME_FDE_TYPE_PCINC
444-
@tab 0 @tab Unwinders perform a (PC >= FRE_START_ADDR) to look up a matching FRE.
448+
@tab 0 @tab Unwinders perform a @*
449+
(PC >= FRE_START_ADDR) to look up a matching FRE.
445450

446451
@item SFRAME_FDE_TYPE_PCMASK
447-
@tab 1 @tab Unwinders perform a (PC & FRE_START_ADDR_AS_MASK >= FRE_START_ADDR_AS_MASK)
452+
@tab 1 @tab Unwinders perform a @*
453+
(PC & FRE_START_ADDR_AS_MASK >= FRE_START_ADDR_AS_MASK)
448454
to look up a matching FRE.
449455

450456
@end multitable
@@ -577,8 +583,10 @@ The SFrame FRE info word is a bitfield split into four parts. From MSB to LSB:
577583

578584
@item 5-6
579585
@tab @code{fre_offset_size}
580-
@tab Size of stack offsets in bytes. Valid values are SFRAME_FRE_OFFSET_1B,
581-
SFRAME_FRE_OFFSET_2B, and SFRAME_FRE_OFFSET_4B.
586+
@tab Size of stack offsets in bytes. Valid values are: @*
587+
SFRAME_FRE_OFFSET_1B, @*
588+
SFRAME_FRE_OFFSET_2B, and @*
589+
SFRAME_FRE_OFFSET_4B.
582590

583591
@item 1-4
584592
@tab @code{fre_offset_count}

0 commit comments

Comments
 (0)