diff mbox

Add -q in help info and doc

Message ID CADNgcExxcG75mYskwGZGNcFHbPyzMA=5y3pAkAGBeeLKvMz2UQ@mail.gmail.com
State Accepted
Headers show

Commit Message

Mingjie Xing June 6, 2014, 8:12 a.m. UTC
Hello,

I notice that "-q" and "--silent" options are not mentioned in gdb's
help information. This patch just adds them and updates the document.

Besides, most options in gdb document are using "-" prefix instead of "--".

ChangeLog

        * gdb.texinfo (Invoking GDB): Add -q and --quiet.
        * main.c (print_gdb_help): Add -q and --silent.

Is it OK?

Best regards,
Mingjie

Comments

Eli Zaretskii June 6, 2014, 8:22 a.m. UTC | #1
> From: Mingjie Xing <mingjie.xing@gmail.com>
> Date: Fri, 6 Jun 2014 16:12:35 +0800
> 
> I notice that "-q" and "--silent" options are not mentioned in gdb's
> help information. This patch just adds them and updates the document.
> 
> Besides, most options in gdb document are using "-" prefix instead of "--".
> 
> ChangeLog
> 
>         * gdb.texinfo (Invoking GDB): Add -q and --quiet.
>         * main.c (print_gdb_help): Add -q and --silent.
> 
> Is it OK?

Fine with me, thanks.
Pedro Alves June 6, 2014, 10:26 a.m. UTC | #2
On 06/06/2014 09:12 AM, Mingjie Xing wrote:
> Hello,
> 
> I notice that "-q" and "--silent" options are not mentioned in gdb's
> help information. This patch just adds them and updates the document.

I notice it's missing from the man page too.

(cd doc; make man; man ./gdb.1)
Mingjie Xing June 9, 2014, 1:32 a.m. UTC | #3
2014-06-06 18:26 GMT+08:00 Pedro Alves <palves@redhat.com>:
> I notice it's missing from the man page too.
>
> (cd doc; make man; man ./gdb.1)

Yes. But before fixing it, I think It should be better that we can
firstly unify the
long option format. Currently, we use "--" prefix in the help
information, while "-"
in gdb.texinfo. It's confusing for users, though gdb accepts both kinds.

Best regards,
Mingjie
Sergio Durigan Junior June 9, 2014, 4:39 a.m. UTC | #4
On Sunday, June 08 2014, Mingjie Xing wrote:

> 2014-06-06 18:26 GMT+08:00 Pedro Alves <palves@redhat.com>:
>> I notice it's missing from the man page too.
>>
>> (cd doc; make man; man ./gdb.1)
>
> Yes. But before fixing it, I think It should be better that we can
> firstly unify the
> long option format. Currently, we use "--" prefix in the help
> information, while "-"
> in gdb.texinfo. It's confusing for users, though gdb accepts both kinds.

I agree.  And last time I checked, I saw that our manpage is missing
useful options.  I was planning to tackle this in some spare time (not
likely anytime soon), but if Mingjie wants to do that too...

Thanks,
Pedro Alves June 9, 2014, 9:33 a.m. UTC | #5
On 06/09/2014 02:32 AM, Mingjie Xing wrote:
> 2014-06-06 18:26 GMT+08:00 Pedro Alves <palves@redhat.com>:
>> I notice it's missing from the man page too.
>>
>> (cd doc; make man; man ./gdb.1)
> 
> Yes. But before fixing it, I think It should be better that we can
> firstly unify the
> long option format. Currently, we use "--" prefix in the help
> information, while "-"
> in gdb.texinfo. It's confusing for users, though gdb accepts both kinds.

Yes, it's confusing, agreed, but I'd call that an orthogonal issue.

But if you want to fix both issues, then that's great.

TBC, I'm not suggesting you _have_ to fix the man page.
Mingjie Xing June 9, 2014, 9:41 a.m. UTC | #6
2014-06-09 17:33 GMT+08:00 Pedro Alves <palves@redhat.com>:
>
> TBC, I'm not suggesting you _have_ to fix the man page.

Thanks. I've sent a patch to share options between man page and info
page, which should fix it.

Best regards,
Mingjie
diff mbox

Patch

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 9f7fa18..a0fb66d 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -885,10 +885,11 @@  This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
 @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}.
 
 You can run @code{@value{GDBP}} without printing the front material, which describes
-@value{GDBN}'s non-warranty, by specifying @code{-silent}:
+@value{GDBN}'s non-warranty, by specifying @code{--silent}
+(or @code{-q}/@code{--quiet}):
 
 @smallexample
-@value{GDBP} -silent
+@value{GDBP} --silent
 @end smallexample
 
 @noindent
diff --git a/gdb/main.c b/gdb/main.c
index a9fc378..108759d 100644
--- a/gdb/main.c
+++ b/gdb/main.c
@@ -1173,7 +1173,8 @@  Output and user interface control:\n\n\
   fputs_unfiltered (_("\
   --dbx              DBX compatibility mode.\n\
   --xdb              XDB compatibility mode.\n\
-  --quiet            Do not print version number on startup.\n\n\
+  -q, --quiet, --silent\n\
+                     Do not print version number on startup.\n\n\
 "), stream);
   fputs_unfiltered (_("\
 Operating modes:\n\n\