diff mbox series

[20/20] doc, pru: Clean up PRU option documentation [PR122243]

Message ID 20251207001030.1024365-21-sloosemore@baylibre.com
State Committed
Commit ddbc8556c299c9727ca4de0782c4bdf29ce75419
Headers
Series Second set of doc updates for target-specific options |

Checks

Context Check Description
rivoscibot/toolchain-ci-rivos-lint success Lint passed
rivoscibot/toolchain-ci-rivos-apply-patch success Patch applied
rivoscibot/toolchain-ci-rivos-build--newlib-rv64gcv-lp64d-multilib success Build passed
rivoscibot/toolchain-ci-rivos-build--linux-rv64gc_zba_zbb_zbc_zbs-lp64d-multilib success Build passed
rivoscibot/toolchain-ci-rivos-build--linux-rv64gcv-lp64d-multilib success Build passed
rivoscibot/toolchain-ci-rivos-test success Testing passed

Commit Message

Sandra Loosemore Dec. 7, 2025, 12:10 a.m. UTC 
  gcc/ChangeLog
	PR other/122243
	* doc/invoke.texi (Option Summary) <PRU Options>: Fix whitespace
	in option list.
	(PRU Options): Copy-editing.  Index and list negative option forms.
---
 gcc/doc/invoke.texi | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

Comments

Dimitar Dimitrov Dec. 7, 2025, 7:44 p.m. UTC | #1 
On Sat, Dec 06, 2025 at 05:10:30PM -0700, Sandra Loosemore wrote:
> gcc/ChangeLog
> 	PR other/122243
> 	* doc/invoke.texi (Option Summary) <PRU Options>: Fix whitespace
> 	in option list.
> 	(PRU Options): Copy-editing.  Index and list negative option forms.
> ---
>  gcc/doc/invoke.texi | 23 +++++++++++++++--------
>  1 file changed, 15 insertions(+), 8 deletions(-)

Thank you. Looks good.

Regards,
Dimitar
diff mbox series

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 413259f2fe3..fe12ee3a139 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -1301,7 +1301,7 @@  See RS/6000 and PowerPC Options.
 
 @emph{PRU Options} (@ref{PRU Options})
 @gccoptlist{-mmcu=@var{mcu}  -minrt  -mno-relax  -mloop
--mmul -mfillzero -mabi=@var{variant}}
+-mmul  -mfillzero  -mabi=@var{variant}}
 
 @emph{RISC-V Options} (@ref{RISC-V Options})
 @gccoptlist{-mbranch-cost=@var{N-instruction}
@@ -31763,16 +31763,16 @@  are removed.
 This option disables support for static initializers and constructors.
 Beware that the compiler could still generate code with static initializers
 and constructors.  It is up to the programmer to ensure that the source
-program will not use those features.
+program does not use those features.
 
-The minimal startup code would not pass @code{argc} and @code{argv} arguments
+The minimal startup code does not pass @code{argc} and @code{argv} arguments
 to @code{main}, so the latter must be declared as @code{int main (void)}.
 This is already the norm for most firmware projects.
 
 @opindex mmcu
 @item -mmcu=@var{mcu}
-Specify the PRU hardware variant to use.  A correspondingly named
-spec file would be loaded, passing the memory region sizes to
+Specify the PRU hardware variant to use.  A correspondingly-named
+spec file is loaded, passing the memory region sizes to
 the linker and defining hardware-specific C macros.
 
 Newlib provides only the @code{sim} spec, intended for running
@@ -31786,21 +31786,27 @@  Make GCC pass the @option{--no-relax} command-line option to the linker
 instead of the @option{--relax} option.
 
 @opindex mloop
+@opindex mno-loop
 @item -mloop
+@itemx -mno-loop
 Allow (or do not allow) GCC to use the LOOP instruction.
 
 @opindex mmul
+@opindex mno-mul
 @item -mmul
+@itemx -mno-mul
 Allow (or do not allow) GCC to use the PRU multiplier unit.
 
 @opindex mfillzero
+@opindex mno-fillzero
 @item -mfillzero
+@itemx -mno-fillzero
 Allow (or do not allow) GCC to use the FILL and ZERO instructions.
 
 @opindex mabi
 @item -mabi=@var{variant}
 Specify the ABI variant to output code for.  @option{-mabi=ti} selects the
-unmodified TI ABI while @option{-mabi=gnu} selects a GNU variant that copes
+unmodified TI ABI, while @option{-mabi=gnu} selects a GNU variant that copes
 more naturally with certain GCC assumptions.  These are the differences:
 
 @table @samp
@@ -31816,7 +31822,8 @@  GNU always passes and expects a valid return value pointer.
 
 @item Size Of Struct Containing Bit-fields
 TI ABI mandates that struct size is determined by the bit-field type, if it
-contains any.  Whereas GNU allocates the smallest amount of bytes which would
+contains any.  On the other hand,
+GNU allocates the smallest amount of bytes which would
 fit the bit-field.
 
 For example, TI ABI reserves 4 bytes for this struct, whereas GNU reserves
@@ -31831,7 +31838,7 @@  TI ABI mandates that volatile bit-fields are accessed using their type.
 In contrast, GNU ABI uses the smallest integer type fitting the bit-field.
 
 For example, TI ABI requires a single load of 4 bytes for the
-following bit-field.  Whereas GNU generates a load of 1 byte:
+following bit-field.  GNU generates a load of 1 byte:
 
 @smallexample
 struct S @{ volatile int i:1; @};