From: Eli Zaretskii <eliz@gnu.org>
To: dje@google.com
Cc: gdb-patches@sourceware.org
Subject: Re: [doc RFA] New option -nh
Date: Tue, 02 Oct 2012 18:12:00 -0000 [thread overview]
Message-ID: <83r4pgagl6.fsf@gnu.org> (raw)
In-Reply-To: <yjt2sj9wbwd4.fsf@ruffy2.mtv.corp.google.com>
> Date: Tue, 02 Oct 2012 10:46:15 -0700
> From: dje@google.com
>
> This needs a doc RFA.
Here goes:
> +* New command line options:
> +
> +-nh Like -nx, but only disable auto-loading of ~/.gdbinit.
I'd suggest to mention in parentheses what -nx does that -nh doesn't.
> +@anchor{-nh}
> +@item -nh
> +@cindex @code{--nh}
> +Do not execute commands found in @file{~/.gdbinit}, the init file
> +in your home directory.
> +@xref{Startup}.
Likewise here. The previous paragraph, that describes -nx, says:
@itemx -n
@cindex @code{--nx}
@cindex @code{-n}
Do not execute commands found in any initialization files. Normally,
@value{GDBN} executes the commands in these files after all the command
options and arguments have been processed. @xref{Command Files,,Command
Files}.
There's almost nothing in common between this verbiage and what you
suggested for -nh. The reader will have hard time figuring out that
-nh does a subset of what -nx does.
I see 2 possible ways to make the relations between these 2 switches
clear (and I'm okay with either one of them):
. rewrite the -nx documentation to explicitly mention ~/.gdbinit,
site-wide gdbinit etc., in the same style as you described -nh;
then you can leave the -nh description alone, or
. Add a sentence to your -nh description which says something like
"Unlike @code{--nx}, ..." and go on to describe what -nx does, but
-nh does not.
Makes sense?
next prev parent reply other threads:[~2012-10-02 18:12 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-10-02 17:46 dje
2012-10-02 18:12 ` Eli Zaretskii [this message]
2012-10-02 20:54 ` Sergio Durigan Junior
2012-10-04 17:21 ` dje
2012-10-04 17:46 ` Eli Zaretskii
2012-10-05 6:55 ` Sergio Durigan Junior
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83r4pgagl6.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=dje@google.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox