From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-95017-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 2753 invoked by alias); 2 Oct 2012 18:12:44 -0000
Received: (qmail 2726 invoked by uid 22791); 2 Oct 2012 18:12:42 -0000
X-SWARE-Spam-Status: No, hits=-4.3 required=5.0	tests=AWL,BAYES_00,KHOP_SPAMHAUS_DROP,KHOP_THREADED,RCVD_IN_DNSWL_NONE,RCVD_IN_HOSTKARMA_NO,SPF_SOFTFAIL
X-Spam-Check-By: sourceware.org
Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169)    by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Tue, 02 Oct 2012 18:12:34 +0000
Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0MBA00D001X7AX00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Tue, 02 Oct 2012 20:12:12 +0200 (IST)
Received: from HOME-C4E4A596F7 ([87.69.4.28]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0MBA00D6E2KCAW30@a-mtaout21.012.net.il>; Tue, 02 Oct 2012 20:12:12 +0200 (IST)
Date: Tue, 02 Oct 2012 18:12:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [doc RFA] New option -nh
In-reply-to: <yjt2sj9wbwd4.fsf@ruffy2.mtv.corp.google.com>
To: dje@google.com
Cc: gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83r4pgagl6.fsf@gnu.org>
References: <yjt2sj9wbwd4.fsf@ruffy2.mtv.corp.google.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2012-10/txt/msg00025.txt.bz2

> 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?