diff mbox series

Clear --help=language and --help=common interaction.

Message ID 80ba9b7d-2125-a1ff-a5a8-c86a18d3f2dc@suse.cz
State New
Headers show
Series Clear --help=language and --help=common interaction. | expand

Commit Message

Martin Liška March 2, 2020, 1:28 p.m. UTC 
Hi.

For situations like -Q --help=warning,c one can't see a warning
that is common. For that one needs to use -Q --help=warning,common.
My patch explains the behavior in documentation.

Ready to be installed?
Thanks,
Martin

gcc/ChangeLog:

2020-03-02  Martin Liska  <mliska@suse.cz>

	PR c/93886
	PR c/93887
	* doc/invoke.texi: Clarify --help=language and --help=common
	interaction.
---
  gcc/doc/invoke.texi | 3 ++-
  1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Joseph Myers March 2, 2020, 10:52 p.m. UTC | #1 
On Mon, 2 Mar 2020, Martin Liška wrote:

> +version of GCC@.  If an option is supported by all languages, one needs
> +to use @var{common} qualifier instead.

"common" is literal text, so it should be @samp{common} not @var{common}, 
and the existing documentation here describes it as a "class" with other 
things such as "undocumented" or "joined" being "qualifiers"
Martin Liška March 3, 2020, 8:16 a.m. UTC | #2 
On 3/2/20 11:52 PM, Joseph Myers wrote:
> On Mon, 2 Mar 2020, Martin Liška wrote:
> 
>> +version of GCC@.  If an option is supported by all languages, one needs
>> +to use @var{common} qualifier instead.
> 
> "common" is literal text, so it should be @samp{common} not @var{common},
> and the existing documentation here describes it as a "class" with other
> things such as "undocumented" or "joined" being "qualifiers"
> 

Thank you for the comments. I've got an updated version of the patch.

Martin
Joseph Myers March 3, 2020, 10:46 p.m. UTC | #3 
On Tue, 3 Mar 2020, Martin Liška wrote:

> On 3/2/20 11:52 PM, Joseph Myers wrote:
> > On Mon, 2 Mar 2020, Martin Liška wrote:
> > 
> > > +version of GCC@.  If an option is supported by all languages, one needs
> > > +to use @var{common} qualifier instead.
> > 
> > "common" is literal text, so it should be @samp{common} not @var{common},
> > and the existing documentation here describes it as a "class" with other
> > things such as "undocumented" or "joined" being "qualifiers"
> > 
> 
> Thank you for the comments. I've got an updated version of the patch.

This version is OK.
diff mbox series

Patch

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 4f88fe68999..e43d954283f 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -1665,7 +1665,8 @@  option.
 @item @var{language}
 Display the options supported for @var{language}, where
 @var{language} is the name of one of the languages supported in this
-version of GCC@.
+version of GCC@.  If an option is supported by all languages, one needs
+to use @var{common} qualifier instead.
 
 @item @samp{common}
 Display the options that are common to all languages.