Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jan Kratochvil <jan.kratochvil@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [patch 4/3] readline-6.2: Substitute inc-hist.texinfo
Date: Mon, 02 May 2011 14:35:00 -0000	[thread overview]
Message-ID: <E1QGuD5-0002BT-LG@fencepost.gnu.org> (raw)
In-Reply-To: <20110502141121.GA19958@host1.jankratochvil.net> (message from	Jan Kratochvil on Mon, 2 May 2011 16:11:21 +0200)

> Date: Mon, 2 May 2011 16:11:21 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> 
> Used slightly alternative one with IMO better reference and I have also kept
> hsuser.texi in place as readline/ in src/ is no longer a standalone readline
> distribution anyway.

Thanks.

However,...

> --- a/readline/doc/hsuser.texi
> +++ b/readline/doc/hsuser.texi
> @@ -26,9 +26,10 @@ into another language, under the above conditions for modified versions.
>  @node Using History Interactively
>  @chapter Using History Interactively
>  
> -@ifclear BashFeatures
> -@defcodeindex bt
> -@end ifclear
> +@c GDB bundling modification:
> +@c @ifclear BashFeatures
> +@c @defcodeindex bt
> +@c @end ifclear

Why do we need to comment this out?  If BashFeatures is not set, the
@defcodeindex line will not be in effect anyway.  Is something setting
BashFeatures anywhere when we build our docs?

>  This chapter describes how to use the @sc{gnu} History Library interactively,
>  from a user's standpoint.  It should be considered a user's guide.  For
>  information on using the @sc{gnu} History Library in your own programs,
> -@pxref{Programming with GNU History}.
> +@c GDB bundling modification:
> +@pxref{Programming with GNU History, , , history, GNU History Library}.
>  @end ifclear

Is this because the referenced node is only in the separate
history.info manual, which is not part of hsuser.texi?  If so, this is
actually a bug in Readline docs which should be fixed upstream in a
way that allows any project to include hsuser.texi without making such
changes.  For example:

 @ifset HsUser
 @pxref{Programming with GNU History, , , history, GNU History Library}.
 @end ifset
 @ifclear HsUser
 @pxref{Programming with GNU History}.
 @end ifclear

Then projects that include just hsuser.texi will need to pass the
"-DHsUser" switch to makeinfo, while Readline will not.

I'm okay with making these changes for now, to allow people building
GDB without failures.  But if Chet accepts the above change, we should
switch to it in GDB, so that our doc/Makefile.in is ready for the next
upstream release of Readline.


  reply	other threads:[~2011-05-02 14:35 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-02 14:11 Jan Kratochvil
2011-05-02 14:35 ` Eli Zaretskii [this message]
2011-05-02 16:20   ` Jan Kratochvil
2011-05-02 17:06     ` Eli Zaretskii
2011-05-02 17:11       ` Jan Kratochvil

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=E1QGuD5-0002BT-LG@fencepost.gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=jan.kratochvil@redhat.com \
    /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