This is the mail archive of the libc-alpha@sources.redhat.com 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]

Some texinfo error messages fixed


I get a couple of messages like:

   /var/glibc-cvs/libc/manual//creature.texi:220: warning: 
   @strong{Note:} produces a spurious cross-reference in Info; 
   reword to avoid that.

I suggest the fixes below.

I also get a number of error messages like 

   /var/glibc-cvs/libc/manual//summary.texi:9381: 
   Cross reference to nonexistent node `Threads and Signal Handling' 
   (perhaps incorrect sectioning?).

It appears that these actually refer to libc/linuxthreads/linuxthreads.texi.
I configured with

    --without-cvs \
    --prefix=/usr \
    --with-tls \
    --enable-add-ons \
    --enable-kernel=$KERNELVERSION \
    --with-headers=$KERNELDIR/include \
    --disable-profile \

and that build nptl, not linuxthreads.

What are the plans? I could perhaps do the necessary rewrites. I checked
the text about the sem_* functions against the versions in
nptl/sysdep/unix/sysv/linux/sem*.c, and found no important
discrepancies. Should I do that with the rest of the functions? Do you
have any preferences at to how it is integrated into the make?
I have not figured out how it was integrated before, I saw no reference
to the file in the Makefile (linuxthreads/Makefile and manual/Makefile).

If there are any important differences between the two, these should
probably be factored out and the right version included depending on the
configuration. The choice should happen in manual/Makefile, not?

Is there any easy way to make just the manual? I use a separate build
directory, but the make creates a lot of files in the source directory
libc/manual. This happens at make install time, so the files are created
with root,root ownership. Running "make info" in the build directory to
check the changes produced a couple of gcc compiles with complaints that
asm/unistd.h does not exist. Ouphh. Is it worth it to unravel all that?

What are the constraints, really? I mean, If I rewrote manual/Makefile
to create the .inf, .html, etc. during regular make (or "make all"), and
install the results at "make install" time, what else should I ensure?

Regards, Enrique

Index: manual/arith.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/arith.texi,v
retrieving revision 1.76
diff -u -r1.76 arith.texi
--- manual/arith.texi	6 Oct 2004 03:02:14 -0000	1.76
+++ manual/arith.texi	15 Oct 2004 18:48:04 -0000
@@ -418,10 +418,12 @@
 This function returns a nonzero value if @var{x} is a ``not a number''
 value, and zero otherwise.
 
-@strong{Note:} The @code{isnan} macro defined by @w{ISO C99} overrides
+@quotation Note
+The @code{isnan} macro defined by @w{ISO C99} overrides
 the BSD function.  This is normally not a problem, because the two
 routines behave identically.  However, if you really need to get the BSD
 function for some reason, you can write
+@end quotation
 
 @smallexample
 (isnan) (x)
@@ -969,10 +971,12 @@
 bits in the @dfn{control word}.  In C, traps result in the program
 receiving the @code{SIGFPE} signal; see @ref{Signal Handling}.
 
-@strong{Note:} @w{IEEE 754} says that trap handlers are given details of
+@quotation Note
+@w{IEEE 754} says that trap handlers are given details of
 the exceptional situation, and can set the result value.  C signals do
 not provide any mechanism to pass this information back and forth.
 Trapping exceptions in C is therefore not very useful.
+@end quotation
 
 It is sometimes necessary to save the state of the floating-point unit
 while you perform some calculation.  The library provides functions
@@ -1722,9 +1726,11 @@
 machines that don't, the macros can be very slow.  Therefore, you should
 not use these functions when NaN is not a concern.
 
-@strong{Note:} There are no macros @code{isequal} or @code{isunequal}.
+@quotation Note
+There are no macros @code{isequal} or @code{isunequal}.
 They are unnecessary, because the @code{==} and @code{!=} operators do
 @emph{not} throw an exception if one or both of the operands are NaN.
+@end quotation
 
 @node Misc FP Arithmetic
 @subsection Miscellaneous FP arithmetic functions
Index: manual/creature.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/creature.texi,v
retrieving revision 1.26
diff -u -r1.26 creature.texi
--- manual/creature.texi	13 Feb 2001 23:23:18 -0000	1.26
+++ manual/creature.texi	15 Oct 2004 18:48:04 -0000
@@ -215,10 +215,12 @@
 #define _SVID_SOURCE
 @end smallexample
 
+@quotation Note
 Note that if you do this, you must link your program with the BSD
 compatibility library by passing the @samp{-lbsd-compat} option to the
-compiler or linker.  @strong{Note:} If you forget to do this, you may
+compiler or linker.  Otherwise you forget to do this, you may
 get very strange errors at run time.
+@end quotation
 @end defvr
 
 @comment (none)
Index: manual/filesys.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/filesys.texi,v
retrieving revision 1.96
diff -u -r1.96 filesys.texi
--- manual/filesys.texi	7 Nov 2003 22:59:20 -0000	1.96
+++ manual/filesys.texi	15 Oct 2004 18:48:09 -0000
@@ -3188,12 +3188,14 @@
 file name.  Usually the template string is something like
 @samp{/tmp/@var{prefix}XXXXXX}, and each program uses a unique @var{prefix}.
 
-@strong{Note:} Because @code{mktemp} and @code{mkstemp} modify the
+@quotation Note
+Because @code{mktemp} and @code{mkstemp} modify the
 template string, you @emph{must not} pass string constants to them.
 String constants are normally in read-only storage, so your program
 would crash when @code{mktemp} or @code{mkstemp} tried to modify the
 string.  These functions are declared in the header file @file{stdlib.h}.
 @pindex stdlib.h
+@end quotation
 
 @comment stdlib.h
 @comment Unix
Index: manual/math.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/math.texi,v
retrieving revision 1.67
diff -u -r1.67 math.texi
--- manual/math.texi	28 Aug 2001 08:05:40 -0000	1.67
+++ manual/math.texi	15 Oct 2004 18:48:11 -0000
@@ -1366,11 +1366,13 @@
 This function returns the next pseudo-random number in the sequence.
 The value returned ranges from @code{0} to @code{RAND_MAX}.
 
-@strong{Note:} Temporarily this function was defined to return a
+@quotation Note
+Temporarily this function was defined to return a
 @code{int32_t} value to indicate that the return value always contains
 32 bits even if @code{long int} is wider.  The standard demands it
 differently.  Users must always be aware of the 32-bit limitation,
 though.
+@end quotation
 @end deftypefun
 
 @comment stdlib.h
Index: manual/memory.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/memory.texi,v
retrieving revision 1.77
diff -u -r1.77 memory.texi
--- manual/memory.texi	25 Feb 2003 10:10:35 -0000	1.77
+++ manual/memory.texi	15 Oct 2004 18:48:16 -0000
@@ -2323,10 +2323,12 @@
 variable-sized arrays.
 @end itemize
 
-@strong{Note:} If you mix use of @code{alloca} and variable-sized arrays
+@quotation Note
+If you mix use of @code{alloca} and variable-sized arrays
 within one function, exiting a scope in which a variable-sized array was
 declared frees all blocks allocated with @code{alloca} during the
 execution of that scope.
+@end quotation
 
 
 @node Resizing the Data Segment
Index: manual/resource.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/resource.texi,v
retrieving revision 1.14
diff -u -r1.14 resource.texi
--- manual/resource.texi	29 Apr 2004 21:55:09 -0000	1.14
+++ manual/resource.texi	15 Oct 2004 18:48:18 -0000
@@ -591,7 +591,9 @@
 for something like I/O, its absolute priority is irrelevant.
 
 @cindex runnable process
-@strong{Note:}  The term ``runnable'' is a synonym for ``ready to run.''
+@quotation Note
+The term ``runnable'' is a synonym for ``ready to run.''
+@end quotation
 
 When two processes are running or ready to run and both have the same
 absolute priority, it's more interesting.  In that case, who gets the
@@ -663,9 +665,11 @@
 its absolute priority when the process isn't getting its entitled share
 and lowers it when the process is exceeding it.
 
-@strong{Note:}  The absolute priority is sometimes called the ``static
+@quotation Note
+The absolute priority is sometimes called the ``static
 priority.''  We don't use that term in this manual because it misses the
 most important feature of the absolute priority:  its absoluteness.
+@end quotation
 
 
 @node Realtime Scheduling
Index: manual/time.texi
===================================================================
RCS file: /cvs/glibc/libc/manual/time.texi,v
retrieving revision 1.94
diff -u -r1.94 time.texi
--- manual/time.texi	8 Sep 2003 07:25:36 -0000	1.94
+++ manual/time.texi	15 Oct 2004 18:48:22 -0000
@@ -1649,10 +1649,12 @@
 
 Leading zeroes are permitted but not required.
 
-@strong{Note:} The Unix specification says the upper bound on this value
+@quotation Note
+The Unix specification says the upper bound on this value
 is @code{61}, a result of a decision to allow double leap seconds.  You
 will not see the value @code{61} because no minute has more than one
 leap second, but the myth persists.
+@end quotation
 
 @item %OS
 Same as @code{%S} but using the locale's alternative numeric symbols.



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