[Bug other/31355] New: --help=<language> option isn't documented.

[Bug other/31355] New: --help=<language> option isn't documented.

[brooks at gcc dot gnu dot org]

The documentation in invoke.texi for the --help= option only lists the
"optimizers", "warnings", "target", and "params" values that the option can
take.  However, it can also take a language name as a value, and this isn't
documented.


-- 
           Summary: --help=<language> option isn't documented.
           Product: gcc
           Version: 4.3.0
            Status: UNCONFIRMED
          Severity: normal
          Priority: P3
         Component: other
        AssignedTo: unassigned at gcc dot gnu dot org
        ReportedBy: brooks at gcc dot gnu dot org


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355

[Bug driver/31355] --help=<language> option isn't documented.

[pinskia at gcc dot gnu dot org]

------- Comment #1 from pinskia at gcc dot gnu dot org  2007-03-26 00:34 -------
Confirmed.


-- 

pinskia at gcc dot gnu dot org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |nickc at redhat dot com
             Status|UNCONFIRMED                 |NEW
          Component|other                       |driver
     Ever Confirmed|0                           |1
           Keywords|                            |documentation
   Last reconfirmed|0000-00-00 00:00:00         |2007-03-25 23:34:27
               date|                            |


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355

[Bug driver/31355] --help=<language> option isn't documented.

[nickc at redhat dot com]

------- Comment #2 from nickc at redhat dot com  2007-03-28 13:40 -------
Subject: Re:  --help=<language> option isn't documented.

Hi Brooks,

   The attached patch adds this missing documentation.  It also takes 
care of a small bug, whereby the name of the language whose options were 
being displayed was not always included in the output of the 
--help=<language> switch.

   Unfortunately due to some problem with the bugzilla system I am 
unable to upload the patch, so I have had to attach it to this email.

Cheers
   Nick

gcc/ChangeLog
2007-03-28  Nick Clifton  <nickc@redhat.com>

        PR driver/31355
        * doc/invoke.texi (--help=): Document that it accepts a language
        name as a parameter.
        Remove claim that --help=target does not behave in the same way as
        --target-help with respect to the assembler and linker.
        * opts.c (print_specific_help): If a language name has not been
        selected then choose the first one.
Index: gcc/doc/invoke.texi
===================================================================
--- gcc/doc/invoke.texi (revision 123290)
+++ gcc/doc/invoke.texi (working copy)
@@ -1100,8 +1100,9 @@ line options for each tool.
 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
 Print (on the standard output) a description of the command line
 options understood by the compiler that fit into a specific class.
-The class can be one of @var{optimizers}, @var{warnings}, @var{target}
-or @var{params}:
+The class can be one of @var{optimizers}, @var{warnings}, @var{target},
+@var{params} or a language name such as @var{C}, @var{C++} etc.  The
+following table gives the meaning of the class names:

 @table @gcctabopt
 @item @var{optimizers}
@@ -1113,14 +1114,21 @@ This will display all of the options con
 produced by the compiler.

 @item @var{target}
-This will display target-specific options.  Unlike the
-@option{--target-help} option however, target-specific options of the
-linker and assembler will not be displayed.  This is because those
-tools do not currently support the extended @option{--help=} syntax.
+This will display target-specific options.  This option is basically
+the same as @option{--target-help}.

 @item @var{params}
 This will display the values recognized by the @option{--param}
 option.
+
+@item @var{C}
+@itemx @var{C++}
+@itemx @var{Objc}
+@itemx @var{Fortran}
+@itemx @var{Ada}
+@itemx @var{Treelang}
+This will display the options supported by the specified language
+front-end.
 @end table

 It is possible to further refine the output of the @option{--help=}
Index: gcc/opts.c
===================================================================
--- gcc/opts.c  (revision 123290)
+++ gcc/opts.c  (working copy)
@@ -893,7 +893,11 @@ print_specific_help (unsigned int includ
              descrip_extra = lang_names [i];
            }
          else
-           description = _("The following options are supported by, amoung
others, the language ");
+           {
+             description = _("The following options are supported by, amoung
others, the language ");
+             if (* descrip_extra == '\0')
+               descrip_extra = lang_names [i];
+           }
          break;
        }
     }


-- 


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355

[Bug driver/31355] --help=<language> option isn't documented.

[brooks at gcc dot gnu dot org]

------- Comment #3 from brooks at gcc dot gnu dot org  2007-03-28 19:22 -------
The patch tracker missed the patch I'd already posted for this one as well:
http://gcc.gnu.org/ml/gcc-patches/2007-03/msg01655.html

I think our fixes are fairly equivalent here; yours specifies the list of
language, whereas mine uses @var{language} -- which I think is slightly better,
because the list of languages isn't necessarily fixed (and you missed obj-c++),
though I could see yours as being slightly clearer.  However, note that my
patch includes some formatting fixes to this section, which should be
incorporated regardless.

(Note, by the way, that the small problem you mention in --help=<language>
output is Bug #31356.  :) )


-- 

brooks at gcc dot gnu dot org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         AssignedTo|unassigned at gcc dot gnu   |brooks at gcc dot gnu dot
                   |dot org                     |org
             Status|NEW                         |ASSIGNED
   Last reconfirmed|2007-03-25 23:34:27         |2007-03-28 19:22:44
               date|                            |


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355

[Bug driver/31355] --help=<language> option isn't documented.

[nickc at redhat dot com]

------- Comment #4 from nickc at redhat dot com  2007-03-29 11:08 -------
Subject: Re:  --help=<language> option isn't documented.

Hi Brooks,

> The patch tracker missed the patch I'd already posted for this one as well:
> http://gcc.gnu.org/ml/gcc-patches/2007-03/msg01655.html
> 
> I think our fixes are fairly equivalent here; yours specifies the list of
> language, whereas mine uses @var{language} -- which I think is slightly better,
> because the list of languages isn't necessarily fixed (and you missed obj-c++),
> though I could see yours as being slightly clearer.  However, note that my
> patch includes some formatting fixes to this section, which should be
> incorporated regardless.

Agreed, your patch is superior to mine.

> (Note, by the way, that the small problem you mention in --help=<language>
> output is Bug #31356.  :) )

:-)

Cheers
   Nick


-- 


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355

[Bug driver/31355] --help=<language> option isn't documented.

[brooks at gcc dot gnu dot org]

------- Comment #5 from brooks at gcc dot gnu dot org  2007-04-04 19:32 -------
Fixed in svn 123497:
(http://gcc.gnu.org/viewcvs?root=gcc&view=rev&rev=123497)


-- 

brooks at gcc dot gnu dot org changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|ASSIGNED                    |RESOLVED
         Resolution|                            |FIXED


http://gcc.gnu.org/bugzilla/show_bug.cgi?id=31355