This is the mail archive of the libc-alpha@sourceware.org mailing list for the glibc project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Clean up glibc version numbers in manual


On Fri, 24 Feb 2012, Roland McGrath wrote:

> > +libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
> > +	libm-err.texi version.texi
> 
> Usual convention is to indent to after "= ".

Changed in this version.

> > +# Generate a file with the version number.
> > +version.texi: $(common-objpfx)config.make
> > +	echo "@set VERSION $(version)" > version-tmp
> > +	$(move-if-change) version-tmp version.texi
> > +	touch $@
> 
> It seems odd to both use move-if-change and always touch the file.

This was following what the rule immediately above does....

> If you always touch it, just do "> $@T" and "mv -f $@T $@" as usual.

Anyway, changed like that in this version.

> > @@ -176,7 +184,7 @@ realclean: distclean
> >  	-rm -f texis summary.texi stamp-summary *.c.texi dir-add.texi
> >  	-rm -f $(foreach index,$(indices),libc.$(index) libc.$(index)s)
> >  	-rm -f libc.log libc.aux libc.toc dir-add.texinfo
> > -	-rm -f top-menu.texi chapters.texi
> > +	-rm -f top-menu.texi chapters.texi version.texi
> 
> Why not just use libc-texi-generated here too?

Changed in this version.  Reference to dir-add.texinfo (maybe an old name 
for dir-add.texi) removed.

In general we haven't really tried to make "make distclean" etc. work well 
(since builds outside the source directory are required) - and the reason 
this is "realclean" not "distclean" is because generated files from 
manuals used to be shipped in releases (I've filed bug 13750 for moving 
those generated files out of the source directory completely now they are 
no longer in releases).

> > +@c @set EDITION 0.13
> > +@c @set ISBN 1-882114-55-8
> 
> I think it merits having a comment explaining that we're diking out all the
> text associated with printed editions, pending resolving how those will be
> handled.  For each of the other blocks below, a short comment referring to
> the explanation above.  That makes it easier to be sure we clean up all the
> old cruft when we figure out the new plan.

Added in this version.

2012-02-24  Joseph Myers  <joseph@codesourcery.com>

	* manual/Makefile (libc-texi-generated): New variable.  Include
	version.texi.
	(libc.dvi, libc.pdf, libc.info, libc/index.html): Depend on
	$(libc-texi-generated), not duplicated list of files.
	(version.texi): New rule.
	(realclean): Remove $(libc-texi-generated), not individual files
	from that list.  Do not remove dir-add.texinfo.
	* manual/libc.texinfo: Comment out uses of edition numbers and
	references to printed manual.  Remove last-updated dates.
	(EDITION): Comment out.
	(ISBN): Likewise.
	(VERSION, UPDATED): Remove.
	(version.texi): Include.

diff --git a/manual/Makefile b/manual/Makefile
index df96abc..fdf20cb 100644
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -76,12 +76,15 @@ chapters.% top-menu.%: libc-texinfo.sh $(texis) Makefile
 			       '$(add-chapters)' \
 			       '$(appendices) $(licenses)'
 
-libc.dvi libc.pdf libc.info: chapters.texi top-menu.texi dir-add.texi \
-			     libm-err.texi
+# Generated files directly included from libc.texinfo.
+libc-texi-generated = chapters.texi top-menu.texi dir-add.texi \
+		      libm-err.texi version.texi
+
+libc.dvi libc.pdf libc.info: $(libc-texi-generated)
 libc.dvi libc.pdf: texinfo.tex
 
 html: libc/index.html
-libc/index.html: chapters.texi top-menu.texi dir-add.texi libm-err.texi
+libc/index.html: $(libc-texi-generated)
 	$(MAKEINFO) --html libc.texinfo
 
 # Generate the summary from the Texinfo source files for each chapter.
@@ -110,6 +113,11 @@ stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
 	$(move-if-change) libm-err-tmp libm-err.texi
 	touch $@
 
+# Generate a file with the version number.
+version.texi: $(common-objpfx)config.make
+	echo "@set VERSION $(version)" > $@T
+	mv -f $@T $@
+
 # Generate Texinfo files from the C source for the example programs.
 %.c.texi: examples/%.c
 	sed -e 's,[{}],@&,g'				\
@@ -173,10 +181,10 @@ clean: mostlyclean
 distclean: clean
 indices = cp fn pg tp vr ky
 realclean: distclean
-	-rm -f texis summary.texi stamp-summary *.c.texi dir-add.texi
+	-rm -f texis summary.texi stamp-summary *.c.texi
 	-rm -f $(foreach index,$(indices),libc.$(index) libc.$(index)s)
-	-rm -f libc.log libc.aux libc.toc dir-add.texinfo
-	-rm -f top-menu.texi chapters.texi
+	-rm -f libc.log libc.aux libc.toc
+	-rm -f $(libc-texi-generated)
 
 .PHONY: install subdir_install installdirs install-data
 install-data subdir_install: install
diff --git a/manual/libc.texinfo b/manual/libc.texinfo
index e57e4d3..f1c4301 100644
--- a/manual/libc.texinfo
+++ b/manual/libc.texinfo
@@ -17,19 +17,24 @@
 @c @smallbook
 @comment %**end of header (This is for running Texinfo on a region.)
 
+@c Everything related to printed editions is disabled until we have
+@c resolved how to keep them in sync with the master sources of the
+@c manual.
 @c sold 0.06/1.09, print run out 21may96
-@set EDITION 0.13
-@set VERSION 2.14
-@set UPDATED 2011-07-19
-@set ISBN 1-882114-55-8
+@c @set EDITION 0.13
+@c @set ISBN 1-882114-55-8
+
+@include version.texi
 
 @set FDL_VERSION 1.3
 
 @copying
 This file documents the GNU C library.
 
-This is Edition @value{EDITION}, last updated @value{UPDATED},
-of @cite{The GNU C Library Reference Manual}, for version @value{VERSION}.
+This is
+@c Disabled (printed editions, see above).
+@c Edition @value{EDITION} of
+@cite{The GNU C Library Reference Manual}, for version @value{VERSION}.
 
 Copyright @copyright{} 1993--2012 Free Software Foundation, Inc.
 
@@ -59,22 +64,23 @@ supports it in developing GNU and promoting software freedom.''
 @center with
 @center Richard M. Stallman, Roland McGrath, Andrew Oram, and Ulrich Drepper
 @sp 3
-@center Edition @value{EDITION}
-@sp 1
-@center last updated @value{UPDATED}
-@sp 1
+@c Disabled (printed editions, see above).
+@c @center Edition @value{EDITION}
+@c @sp 1
 @center for version @value{VERSION}
 @page
 @vskip 0pt plus 1filll
 @insertcopying
 
-@sp 2
-Published by the @uref{http://www.fsf.org/, Free Software Foundation} @*
+@c Disabled (printed editions, see above).
+@c @sp 2
+@c Published by the @uref{http://www.fsf.org/, Free Software Foundation} @*
 @c ISBN @value{ISBN} @*
 
-@sp 2
-Cover art for the Free Software Foundation's printed edition
-by Etienne Suvasa.
+@c Disabled (printed editions, see above).
+@c @sp 2
+@c Cover art for the Free Software Foundation's printed edition
+@c by Etienne Suvasa.
 
 @end titlepage
 
@@ -84,7 +90,9 @@ by Etienne Suvasa.
 @ifnottex
 @node Top, Introduction, (dir), (dir)
 @top Main Menu
-This is Edition @value{EDITION}, last updated @value{UPDATED}, of
+This is
+@c Disabled (printed editions, see above).
+@c Edition @value{EDITION} of
 @cite{The GNU C Library Reference Manual}, for Version @value{VERSION}
 of the GNU C Library.
 @end ifnottex

-- 
Joseph S. Myers
joseph@codesourcery.com


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]