[doc, committed] fix verb tenses in invoke.texi

Sandra Loosemore sandra@codesourcery.com
Sun Jan 4 23:21:00 GMT 2015


This is another in my series of boring tech-writer patches to the GCC 
user documentation.

I noticed that the documentation for several recently-added command-line 
options (e.g., the -fsanitize options) was written in the future tense 
rather than the present.  Generally, future tense is only appropriate 
when describing features that aren't implemented yet, or when 
contrasting GCC's compile-time behavior with the future run-time 
behavior of the program; otherwise it's better to say "this option does 
foo" rather than "this option will do foo".

I made a pass through all of invoke.texi looking for instances of "will" 
(plus also "was", "were", "would", which are also red flags for 
possibly-inappropriate verb tenses).  I also fixed a few typos and 
markup errors in surrounding text along the way, although I wasn't 
really scanning for those at this time.

Patch checked in under the "obvious fix" rule.

-Sandra


2015-01-04  Sandra Loosemore  <sandra@codesourcery.com>

	gcc/
	* doc/invoke.texi ([-fsized-deallocation]): Copy-edit to fix
	verb tense, etc.
	([-fvtable-verify], [-fvtv-debug]): Likewise.
	([-Wabi]): Likewise.
	([-fmessage-length]): Likewise.
	([-Wsuggest-final-types], [-Wsuggest-final-methods]): Likewise.
	([-Wno-discarded-qualifiers]): Likewise.
	([-Wnodiscarded-array-qualifiers]): Likewise.
	([-Wno-virtual-move-assign]): Likewise.
	([-fsanitize=address], [-fsanitize=thread]): Likewise.
	([-fsanitize=leak], [-fsanitize=undefined]): Likewise.
	([-fsanitize=unreachable], [-fsanitize-recover]): Likewise.
	([-fsanitize-undefined-trap-on-error]): Likewise.
	([-floop-interchange]): Likewise.
	([-ftree-coalesce-inlined-vars]): Likewise.
	([-fvect-cost-model]): Likewise.
	([-flto]): Likewise.
	([--param]): Likewise.
	(Spec Files): Likewise.
	([-mstrict-align]): Likewise.
	([-mfix-cortex-a53-835769]): Likewise.
	([-march], [-mtune]): Likewise.
	([-mpic-register]): Likewise.
	([-munaligned-access]): Likewise.
	([-msp8]): Likewise.
	(EIND and Devices with more than 128 Ki Bytes of Flash): Likewise.
	(AVR Built-in Macros): Likewise.
	([-mpreferred-stack-boundary]): Likewise.
	([-mtune-crtl]): Likewise.
	([-mashf]): Likewise.
	([-mmcu=]): Likewise.
	([-minrt]): Likewise.
	([-maltivec], [-maltivec=be], [-maltivec=le]): Likewise.
	([-mupper-regs]): Likewise.
	([-matomic-model]): Likewise.
	([-mdiv]): Likewise.
	([-mzdcbranch]): Likewise.
	([-mdisable-callt]): Likewise.
	([-msoft-float]): Likewise.
	([-m8byte-align]): Likewise.
	([-fstack-reuse]): Likewise.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: tense.patch
Type: text/x-patch
Size: 33175 bytes
Desc: not available
URL: <http://gcc.gnu.org/pipermail/gcc-patches/attachments/20150104/73d2e781/attachment.bin>


More information about the Gcc-patches mailing list