diff mbox series

Fix various description text issues in *.opt files (PR target/79645)

Message ID 20190308201646.GP7611@tucnak
State New
Headers show
Series Fix various description text issues in *.opt files (PR target/79645) | expand

Commit Message

Jakub Jelinek March 8, 2019, 8:16 p.m. UTC 
Hi!

The PR complained about lack of terminating dot at the end of one option
description, but I've found many others.
The patch ensures that normal option descriptions start with a capital
letter (unless it starts with a keyword, number, or - with tab in the middle of
description, etc.) and ends with a dot, for the Enum descriptions that it
starts with a capital letter and ends with a colon and I've tried to verify
the Warn etc. messages don't start with a capital letter (unless it would be
written that way in the middle of sentence) and don't end with a dot or
period.

Tested on x86_64-linux, ok for trunk?

2019-03-08  Jakub Jelinek  <jakub@redhat.com>

	PR target/79645
	* common.opt (fdiagnostics-show-labels,
	fdiagnostics-show-line-numbers, fdiagnostics-format=,
	fdiagnostics-minimum-margin-width=, fgnat-encodings=, gas-loc-support,
	gas-locview-support, ginline-points, ginternal-reset-location-views):
	Terminate description text with a dot.
	* config/microblaze/microblaze.opt (mxl-prefetch): Likewise.
	* config/mcore/mcore.opt (m210, m340): Likewise.
	* config/epiphany/epiphany.opt (mprefer-short-insn-regs, mcmove,
	mnops=): Start description text with a capital letter.
	* config/arc/arc.opt (msize-level=): Likewise.
	* config/sh/sh.opt (minline-ic_invalidate): Likewise.
	* config/rs6000/sysv4.opt (mno-toc, mtoc, mno-traceback, mshlib,
	mnewlib): Likewise.
	* config/ft32/ft32.opt (msim): Likewise.
	(mft32b, mcompress): Likewise.  Terminate description text with a dot.
	(mnodiv, mnopm): Terminate description text with a dot.
	* config/c6x/c6x.opt (c6x_sdata): Terminate Enum description with
	a colon.
	* config/i386/i386.opt (prefer_vector_width, instrument_return):
	Likewise.
	* config/rx/rx.opt (nofpu): Remove trailing spaces from description
	text.
lto/
	* lang.opt: Terminate description text with a dot.


	Jakub

Comments

Richard Sandiford March 9, 2019, 8:33 a.m. UTC | #1 
Jakub Jelinek <jakub@redhat.com> writes:

> Hi!
>
> The PR complained about lack of terminating dot at the end of one option
> description, but I've found many others.
> The patch ensures that normal option descriptions start with a capital
> letter (unless it starts with a keyword, number, or - with tab in the middle of
> description, etc.) and ends with a dot, for the Enum descriptions that it
> starts with a capital letter and ends with a colon and I've tried to verify
> the Warn etc. messages don't start with a capital letter (unless it would be
> written that way in the middle of sentence) and don't end with a dot or
> period.
>
> Tested on x86_64-linux, ok for trunk?
>
> 2019-03-08  Jakub Jelinek  <jakub@redhat.com>
>
> 	PR target/79645
> 	* common.opt (fdiagnostics-show-labels,
> 	fdiagnostics-show-line-numbers, fdiagnostics-format=,
> 	fdiagnostics-minimum-margin-width=, fgnat-encodings=, gas-loc-support,
> 	gas-locview-support, ginline-points, ginternal-reset-location-views):
> 	Terminate description text with a dot.
> 	* config/microblaze/microblaze.opt (mxl-prefetch): Likewise.
> 	* config/mcore/mcore.opt (m210, m340): Likewise.
> 	* config/epiphany/epiphany.opt (mprefer-short-insn-regs, mcmove,
> 	mnops=): Start description text with a capital letter.
> 	* config/arc/arc.opt (msize-level=): Likewise.
> 	* config/sh/sh.opt (minline-ic_invalidate): Likewise.
> 	* config/rs6000/sysv4.opt (mno-toc, mtoc, mno-traceback, mshlib,
> 	mnewlib): Likewise.
> 	* config/ft32/ft32.opt (msim): Likewise.
> 	(mft32b, mcompress): Likewise.  Terminate description text with a dot.
> 	(mnodiv, mnopm): Terminate description text with a dot.
> 	* config/c6x/c6x.opt (c6x_sdata): Terminate Enum description with
> 	a colon.
> 	* config/i386/i386.opt (prefer_vector_width, instrument_return):
> 	Likewise.
> 	* config/rx/rx.opt (nofpu): Remove trailing spaces from description
> 	text.
> lto/
> 	* lang.opt: Terminate description text with a dot.

OK, thanks.

Richard
diff mbox series

Patch

--- gcc/common.opt.jj	2019-02-25 23:57:00.971009713 +0100
+++ gcc/common.opt	2019-03-08 20:47:17.258098651 +0100
@@ -1251,11 +1251,11 @@  Show the source line with a caret indica
 
 fdiagnostics-show-labels
 Common Var(flag_diagnostics_show_labels) Init(1)
-Show labels annotating ranges of source code when showing source
+Show labels annotating ranges of source code when showing source.
 
 fdiagnostics-show-line-numbers
 Common Var(flag_diagnostics_show_line_numbers) Init(1)
-Show line numbers in the left margin when showing source
+Show line numbers in the left margin when showing source.
 
 fdiagnostics-color
 Common Alias(fdiagnostics-color=,always,never)
@@ -1283,7 +1283,7 @@  Enum(diagnostic_color_rule) String(auto)
 
 fdiagnostics-format=
 Common Joined RejectNegative Enum(diagnostics_output_format)
--fdiagnostics-format=[text|json] Select output format
+-fdiagnostics-format=[text|json] Select output format.
 
 ; Required for these enum values.
 SourceInclude
@@ -1312,7 +1312,7 @@  Amend appropriate diagnostic messages wi
 
 fdiagnostics-minimum-margin-width=
 Common Joined UInteger Var(diagnostics_minimum_margin_width) Init(6)
-Set minimum width of left margin of source code when showing source
+Set minimum width of left margin of source code when showing source.
 
 fdisable-
 Common Joined RejectNegative Var(common_deferred_options) Defer
@@ -1521,7 +1521,7 @@  Enum(dwarf_gnat_encodings) String(minima
 
 fgnat-encodings=
 Common Enum(dwarf_gnat_encodings) Joined RejectNegative Report Undocumented Var(gnat_encodings)
--fgnat-encodings=[all|gdb|minimal]	Select the balance between GNAT encodings and standard DWARF emitted in the debug information
+-fgnat-encodings=[all|gdb|minimal]	Select the balance between GNAT encodings and standard DWARF emitted in the debug information.
 
 ; This option is not documented yet as its semantics will change.
 fgraphite
@@ -2969,11 +2969,11 @@  Generate debug information in default fo
 
 gas-loc-support
 Common Driver Var(dwarf2out_as_loc_support) Init(2)
-Assume assembler support for (DWARF2+) .loc directives
+Assume assembler support for (DWARF2+) .loc directives.
 
 gas-locview-support
 Common Driver Var(dwarf2out_as_locview_support) Init(2)
-Assume assembler support for view in (DWARF2+) .loc directives
+Assume assembler support for view in (DWARF2+) .loc directives.
 
 gcoff
 Common Driver Deprecated
@@ -3009,11 +3009,11 @@  Generate debug information in default ex
 
 ginline-points
 Common Driver Var(debug_inline_points) Init(2)
-Generate extended entry point information for inlined functions
+Generate extended entry point information for inlined functions.
 
 ginternal-reset-location-views
 Common Driver Var(debug_internal_reset_location_views) Init(2)
-Compute locview reset points based on insn length estimates
+Compute locview reset points based on insn length estimates.
 
 gno-
 RejectNegative Joined Undocumented
--- gcc/config/epiphany/epiphany.opt.jj	2019-01-01 12:37:23.560869895 +0100
+++ gcc/config/epiphany/epiphany.opt	2019-03-08 20:51:57.162533437 +0100
@@ -25,7 +25,7 @@  Don't use any of r32..r63.
 
 mprefer-short-insn-regs
 Target Mask(PREFER_SHORT_INSN_REGS)
-preferentially allocate registers that allow short instruction generation.
+Preferentially allocate registers that allow short instruction generation.
 
 mbranch-cost=
 Target RejectNegative Joined UInteger Var(epiphany_branch_cost) Init(3)
@@ -33,11 +33,11 @@  Set branch cost.
 
 mcmove
 Target Mask(CMOVE)
-enable conditional move instruction usage.
+Enable conditional move instruction usage.
 
 mnops=
 Target RejectNegative Joined UInteger Var(epiphany_n_nops) Init(0)
-set number of nops to emit before each insn pattern.
+Set number of nops to emit before each insn pattern.
 
 ; Problems with using the flags from fsub for comparison are:
 ; - Because of underflow (lack of subnormal numbers), different small numbers
--- gcc/config/microblaze/microblaze.opt.jj	2019-01-01 12:37:24.166859952 +0100
+++ gcc/config/microblaze/microblaze.opt	2019-03-08 20:36:55.255243959 +0100
@@ -125,7 +125,7 @@  Description for mxl-mode-novectors.
 
 mxl-prefetch
 Target Mask(PREFETCH)
-Use hardware prefetch instruction
+Use hardware prefetch instruction.
 
 mpic-data-is-text-relative
 Target Mask(PIC_DATA_TEXT_REL)
--- gcc/config/c6x/c6x.opt.jj	2019-01-01 12:37:24.693851305 +0100
+++ gcc/config/c6x/c6x.opt	2019-03-08 20:56:20.086245176 +0100
@@ -43,7 +43,7 @@  Select method for sdata handling.
 
 Enum
 Name(c6x_sdata) Type(enum c6x_sdata)
-Valid arguments for the -msdata= option.
+Valid arguments for the -msdata= option:
 
 EnumValue
 Enum(c6x_sdata) String(none) Value(C6X_SDATA_NONE)
--- gcc/config/mcore/mcore.opt.jj	2019-01-01 12:37:24.884848172 +0100
+++ gcc/config/mcore/mcore.opt	2019-03-08 20:37:42.167478720 +0100
@@ -20,11 +20,11 @@ 
 
 m210
 Target RejectNegative Report InverseMask(M340)
-Generate code for the M*Core M210
+Generate code for the M*Core M210.
 
 m340
 Target RejectNegative Report Mask(M340)
-Generate code for the M*Core M340
+Generate code for the M*Core M340.
 
 m4byte-functions
 Target Report Mask(OVERALIGN_FUNC)
--- gcc/config/arc/arc.opt.jj	2019-01-01 12:37:26.173827028 +0100
+++ gcc/config/arc/arc.opt	2019-03-08 20:52:21.244140668 +0100
@@ -239,7 +239,7 @@  Target RejectNegative Joined Var(arc_cpu
 
 msize-level=
 Target RejectNegative Joined UInteger Var(arc_size_opt_level) Init(-1)
-size optimization level: 0:none 1:opportunistic 2: regalloc 3:drop align, -Os.
+Size optimization level: 0:none 1:opportunistic 2: regalloc 3:drop align, -Os.
 
 misize
 Target Report PchIgnore Var(TARGET_DUMPISIZE)
--- gcc/config/sh/sh.opt.jj	2019-01-01 12:37:31.381741574 +0100
+++ gcc/config/sh/sh.opt	2019-03-08 20:53:16.115245726 +0100
@@ -236,7 +236,7 @@  Increase the IEEE compliance for floatin
 
 minline-ic_invalidate
 Target Report Var(TARGET_INLINE_IC_INVALIDATE)
-inline code to invalidate instruction cache entries after setting up nested function trampolines.
+Inline code to invalidate instruction cache entries after setting up nested function trampolines.
 
 misize
 Target Report RejectNegative Mask(DUMPISIZE)
--- gcc/config/i386/i386.opt.jj	2019-02-24 20:18:03.455719342 +0100
+++ gcc/config/i386/i386.opt	2019-03-08 20:40:09.072082390 +0100
@@ -601,7 +601,7 @@  Use given register vector width instruct
 
 Enum
 Name(prefer_vector_width) Type(enum prefer_vector_width)
-Known preferred register vector length (to use with the -mprefer-vector-width= option)
+Known preferred register vector length (to use with the -mprefer-vector-width= option):
 
 EnumValue
 Enum(prefer_vector_width) String(none) Value(PVW_NONE)
@@ -1087,7 +1087,7 @@  Instrument function exit in instrumented
 
 Enum
 Name(instrument_return) Type(enum instrument_return)
-Known choices for return instrumentation with -minstrument-return=
+Known choices for return instrumentation with -minstrument-return=:
 
 EnumValue
 Enum(instrument_return) String(none) Value(instrument_return_none)
--- gcc/config/rx/rx.opt.jj	2019-01-01 12:37:36.894651120 +0100
+++ gcc/config/rx/rx.opt	2019-03-08 20:41:08.723109422 +0100
@@ -34,7 +34,7 @@  Stores doubles in 32 bits.  This is the
 
 nofpu
 Target RejectNegative Alias(mnofpu)
-Disable the use of RX FPU instructions.  
+Disable the use of RX FPU instructions.
 
 mnofpu
 Target RejectNegative Mask(NO_USE_FPU) Report Undocumented
--- gcc/config/rs6000/sysv4.opt.jj	2019-02-11 17:34:41.331608669 +0100
+++ gcc/config/rs6000/sysv4.opt	2019-03-08 20:53:41.945824432 +0100
@@ -83,11 +83,11 @@  Produce big endian code.
 ;; FIXME: This does nothing.  What should be done?
 mno-toc
 Target RejectNegative
-no description yet.
+No description yet.
 
 mtoc
 Target RejectNegative
-no description yet.
+No description yet.
 
 mprototype
 Target Var(target_prototype) Save
@@ -96,7 +96,7 @@  Assume all variable arg functions are pr
 ;; FIXME: Does nothing.
 mno-traceback
 Target RejectNegative
-no description yet.
+No description yet.
 
 meabi
 Target Report Mask(EABI) Var(rs6000_isa_flags)
@@ -138,7 +138,7 @@  Set the PPC_EMB bit in the ELF flags hea
 
 mshlib
 Target RejectNegative
-no description yet.
+No description yet.
 
 m64
 Target Report RejectNegative Negative(m32) Mask(64BIT) Var(rs6000_isa_flags)
@@ -150,7 +150,7 @@  Generate 32-bit code.
 
 mnewlib
 Target RejectNegative
-no description yet.
+No description yet.
 
 msecure-plt
 Target Report RejectNegative Var(secure_plt, 1) Save
--- gcc/config/ft32/ft32.opt.jj	2019-01-01 12:37:46.641491199 +0100
+++ gcc/config/ft32/ft32.opt	2019-03-08 20:43:44.197573648 +0100
@@ -20,7 +20,7 @@ 
 
 msim
 Target Report Mask(SIM)
-target the software simulator.
+Target the software simulator.
 
 mlra
 Target Report Var(ft32_lra_flag) Init(0) Save
@@ -28,16 +28,16 @@  Use LRA instead of reload.
 
 mnodiv
 Target Report Mask(NODIV)
-Avoid use of the DIV and MOD instructions
+Avoid use of the DIV and MOD instructions.
 
 mft32b
 Target Report Mask(FT32B)
-target the FT32B architecture
+Target the FT32B architecture.
 
 mcompress
 Target Report Mask(COMPRESS)
-enable FT32B code compression
+Enable FT32B code compression.
 
 mnopm
 Target Report Mask(NOPM)
-Avoid placing any readable data in program memory
+Avoid placing any readable data in program memory.
--- gcc/lto/lang.opt.jj	2019-01-01 12:37:53.220383256 +0100
+++ gcc/lto/lang.opt	2019-03-08 20:50:02.667400842 +0100
@@ -47,7 +47,7 @@  Enum(lto_linker_output) String(exec) Val
 
 flinker-output=
 LTO Report Driver Joined RejectNegative Enum(lto_linker_output) Var(flag_lto_linker_output) Init(LTO_LINKER_OUTPUT_UNKNOWN)
-Set linker output type (used internally during LTO optimization)
+Set linker output type (used internally during LTO optimization).
 
 
 fltrans