FreeChainXenon/gcc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

options: Clarifications around option definition records' help texts

Browse source 
gcc/
	* doc/options.texi (Option file format): Clarifications around
	option definition records' help texts.
This commit is contained in:
Thomas Schwinge 2022-03-30 23:00:28 +02:00
parent 6c0e264593
commit 58d78650da
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
gcc/doc/options.texi
View file

@ -175,6 +175,17 @@ used instead of the option's name and the text to the right of the
tab forms the help text. This allows you to elaborate on what type
of argument the option takes.
There is no support for different help texts for different languages.
If an option is supported for multiple languages, use a generic
description that is correct for all of them.
If an option has multiple option definition records (in different
front ends' @file{*.opt} files, and/or @file{gcc/common.opt}, for
example), convention is to not duplicate the help text for each of
them, but instead put a comment like @code{; documented in common.opt}
in place of the help text for all but one of the multiple option
definition records.
@item
A target mask record. These records have one field of the form
@samp{Mask(@var{x})}. The options-processing script will automatically