[PATCH] gas: improve --gsframe documentation

Sam James sam@gentoo.org
Wed Jul 16 06:02:20 GMT 2025


I omitted documentation in 8aad677a12832885acd5be1de8f41e740b8e713d in
error. Rectify that with:
1) changing ---help to mention bare `--gsframe` too, as we're not
   getting rid of that;

2) dropping the 'default: no' text, as it's not useful as-is now we have
   `--gsframe` explicitly documented again. It can be restored as-needed
   later once we have a configure flag for determining the default;

3) adding the new --gsframe=[no|yes] form to as.texi.

	* gas/as.c: Tweak --gsframe= help text.
	* gas/doc/as.texi: Document --gsframe=[no|yes].
---
Jan, does this look better? Notably, I've dropped the 'default: ...' text,
as I think it's noise for now. I should've really clocked that its inclusion
was really hinting that --gsframe itself should remain listed.

 gas/as.c        | 4 ++--
 gas/doc/as.texi | 8 ++++++--
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/gas/as.c b/gas/as.c
index acdf6bb74fd..086f8e55dda 100644
--- a/gas/as.c
+++ b/gas/as.c
@@ -311,8 +311,8 @@ Options:\n\
   fprintf (stream, _("\
                           generate GNU Build notes if none are present in the input\n"));
   fprintf (stream, _("\
-  --gsframe=[no|yes]      whether to generate SFrame stack trace information\n\
-                          (default: no)\n"));
+  --gsframe\n\
+  --gsframe=[no|yes]      whether to generate SFrame stack trace information\n"));
 # if defined (TARGET_USE_SCFI) && defined (TARGET_USE_GINSN)
   fprintf (stream, _("\
   --scfi=experimental     Synthesize DWARF CFI for hand-written asm\n\
diff --git a/gas/doc/as.texi b/gas/doc/as.texi
index 70c25405f87..1cb1fd879a4 100644
--- a/gas/doc/as.texi
+++ b/gas/doc/as.texi
@@ -240,7 +240,7 @@ gcc(1), ld(1), and the Info entries for @file{binutils} and @file{ld}.
  [@b{--gdwarf-<N>}] [@b{--gdwarf-sections}]
  [@b{--gdwarf-cie-version}=@var{VERSION}]
  [@b{--generate-missing-build-notes=[no|yes]}]
- [@b{--gsframe}]
+ [@b{--gsframe}] [@b{--gsframe=[no|yes]}]
  [@b{--hash-size}=@var{N}]
  [@b{--help}] [@b{--target-help}]
  [@b{--info}] [@b{--no-info}]
@@ -860,7 +860,11 @@ configure option.
 
 @item --gsframe
 @itemx --gsframe
-Create @var{.sframe} section from CFI directives.
+@itemx --gsframe=no
+@itemx --gsframe=yes
+Create @var{.sframe} section from CFI directives.  The explicit
+@option{--gsframe=yes} option behaves the same as @option{--gsframe}.
+Generation can be suppressed with @option{--gsframe=no}.
 
 @end ifset
 
-- 
2.50.1



More information about the Binutils mailing list