[16/22] gas: correct .bss documentation for non-ELF

Message ID 941ec65d-0c3b-43b3-89a5-3de6b70a4ad0@suse.com
State New
Headers
Series ELF: correct handling of simplified section directives |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_binutils_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_binutils_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_binutils_check--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_binutils_check--master-arm success Testing passed

Commit Message

Jan Beulich Dec. 15, 2023, 12:16 p.m. UTC
  Only ELF permits the specification of a subsection, and even there not
consistently: csky, mcore, and spu handle .bss similar to .lcomm.
---
Except for H8 this doesn't look to have any effect, because all.texi
blindly enables various object formats. Yet still the documentation ends
up wrong for non-ELF targets.
---
v1: Mention exceptions.
  

Patch

--- a/gas/doc/as.texi
+++ b/gas/doc/as.texi
@@ -4456,7 +4456,12 @@  Some machine configurations provide addi
 * Asciz::                       @code{.asciz "@var{string}"}@dots{}
 * Attach_to_group::             @code{.attach_to_group @var{name}}
 * Balign::                      @code{.balign [@var{abs-expr}[, @var{abs-expr}]]}
+@ifset ELF
 * Bss::                         @code{.bss @var{subsection}}
+@end ifset
+@ifclear ELF
+* Bss::                         @code{.bss}
+@end ifclear
 * Bundle directives::           @code{.bundle_align_mode @var{abs-expr}}, etc
 * Byte::                        @code{.byte @var{expressions}}
 * CFI directives::		@code{.cfi_startproc [simple]}, @code{.cfi_endproc}, etc.
@@ -4801,14 +4806,20 @@  filled in with the value 0x368d (the exa
 the endianness of the processor).  If it skips 1 or 3 bytes, the fill value is
 undefined.
 
+@ifset ELF
 @node Bss
 @section @code{.bss @var{subsection}}
+@end ifset
+@ifclear ELF
+@node Bss
+@section @code{.bss}
+@end ifclear
 @cindex @code{bss} directive
 
 @code{.bss} tells @command{@value{AS}} to assemble the following statements
 onto the end of the bss section.
 @ifset ELF
-For ELF based targets an optional @var{subsection} expression (which must
+For most ELF based targets an optional @var{subsection} expression (which must
 evaluate to a positive integer) can be provided.  In this case the statements
 are appended to the end of the indicated bss subsection.
 @end ifset