[patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[Jan Kratochvil]

Hi,

forgot the patchset had a `make doc' regression:
make: *** No rule to make target `../../../gdb/doc/../../readline/doc/inc-hist.texinfo', needed by `gdb.info'.  Stop.

There was a copy hsuser.texi -> inc-hist.texinfo before with this diff:
	@@ -26,9 +26,9 @@ into another language, under the above c
	 @node Using History Interactively
	 @chapter Using History Interactively
	 
	-@ifclear BashFeatures
	-@defcodeindex bt
	-@end ifclear
	+@c @ifclear BashFeatures
	+@c @defcodeindex bt
	+@c @end ifclear
	 
	 @ifset BashFeatures
	 This chapter describes how to use the @sc{gnu} History Library
	@@ -39,9 +39,9 @@ see the @sc{gnu} Readline Library Manual
	 @end ifset
	 @ifclear BashFeatures
	 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}.
	+from a user's standpoint.  It should be considered a user's guide.
	+For information on using the @sc{gnu} History Library in other programs,
	+see the @sc{gnu} Readline Library Manual.
	 @end ifclear
	 
	 @ifset BashFeatures

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.


Sorry,
Jan


gdb/doc/
2011-05-02  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* Makefile.in (GDB_DOC_SOURCE_INCLUDES): Rename inc-hist.texinfo to
	hsuser.texi.
	* gdb.texinfo <!SYSTEM_READLINE>: Rename inc-hist.texinfo inclusion and
	comment to hsuser.texi.  Change rluser.texi name in the comment.

readline/doc/
2011-05-02  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* hsuser.texi (Using History Interactively): Disable !BashFeatures
	@defcodeindex.  Make the `Programming with GNU History' reference
	external.

--- a/gdb/doc/Makefile.in
+++ b/gdb/doc/Makefile.in
@@ -117,7 +117,7 @@ GDB_DOC_SOURCE_INCLUDES = \
 	$(srcdir)/gpl.texi \
 	$(srcdir)/agentexpr.texi \
 	$(READLINE_DIR)/rluser.texi \
-	$(READLINE_DIR)/inc-hist.texinfo
+	$(READLINE_DIR)/hsuser.texi
 GDB_DOC_BUILD_INCLUDES = \
 	gdb-cfg.texi \
 	GDBvn.texi
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -31008,13 +31008,13 @@ things without first using the debugger to find the facts.
 
 @c The readline documentation is distributed with the readline code
 @c and consists of the two following files:
-@c     rluser.texinfo
-@c     inc-hist.texinfo
+@c     rluser.texi
+@c     hsuser.texi
 @c Use -I with makeinfo to point to the appropriate directory,
 @c environment var TEXINPUTS with TeX.
 @ifclear SYSTEM_READLINE
 @include rluser.texi
-@include inc-hist.texinfo
+@include hsuser.texi
 @end ifclear
 
 
--- 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
 
 @ifset BashFeatures
 This chapter describes how to use the @sc{gnu} History Library
@@ -41,7 +42,8 @@ see the @sc{gnu} Readline Library Manual.
 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
 
 @ifset BashFeatures

Re: [patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[Eli Zaretskii]

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

Re: [patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[Jan Kratochvil]

On Mon, 02 May 2011 16:34:51 +0200, Eli Zaretskii wrote:
> > --- 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?

BTW it was already commented out the same way in readline-5.1.


> If BashFeatures is not set, the
> @defcodeindex line will not be in effect anyway.  Is something setting
> BashFeatures anywhere when we build our docs?

You are right BashFeatures is not set but this is @ifclear.  Therefore:
./../../readline/doc/hsuser.texi:31: Index `bt' already exists.


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

Yes:
./../../readline/doc/hsuser.texi:44: Cross reference to nonexistent node `Programming with GNU History' (perhaps incorrect sectioning?).


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

I guess defined BashFeatures was partially meant for some inclusion, OK.


Thanks,
Jan

Re: [patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[Eli Zaretskii]

> Date: Mon, 2 May 2011 18:20:14 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: gdb-patches@sourceware.org
> 
> On Mon, 02 May 2011 16:34:51 +0200, Eli Zaretskii wrote:
> > > --- 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?
> 
> BTW it was already commented out the same way in readline-5.1.

Yes, I know.  But since we are cleaning up our act, might as well
clean this as well ;-)

> 
> > If BashFeatures is not set, the
> > @defcodeindex line will not be in effect anyway.  Is something setting
> > BashFeatures anywhere when we build our docs?
> 
> You are right BashFeatures is not set but this is @ifclear.

Sorry, I don't know what I was smoking when I wrote that.

But we can't use -DBashFeatures in the makeinfo command line, because
it is really too tied up with Bash.  We need a separate flag.

> >  @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.
> 
> I guess defined BashFeatures was partially meant for some inclusion, OK.

Yes, it was meant for inclusion in the Bash manual.  The problem is
it mentions Bash explicitly, so it's not good for us.

Go ahead and commit your changes, and I will see how to fix that and
submit the changes to Chet.

Thanks.

Re: [patch 4/3] readline-6.2: Substitute inc-hist.texinfo

[Jan Kratochvil]

On Mon, 02 May 2011 19:06:36 +0200, Eli Zaretskii wrote:
> Go ahead and commit your changes,

BTW if not clear this patch is bound to the readline-6.2 rebase which should
wait for comments for some time now.


> and I will see how to fix that and submit the changes to Chet.

Great if you take it yourself.


Thanks,
Jan