Re: [Bug-gnulib] Re: requirements of 'unlocked-io' module

[Paul Eggert]

Bruno Haible <address@hidden> writes:

> Do they all get an optional argument denoting multithread-safety?  Urgh.

Good point.

> I suggest to add a new tag "Notes" to the files in the modules/
> directory. (The .texi file in doc/ should IMO contain user /
> reference documentation, not maintainer documentation.) What do you
> think?

Why not just use the "Description:" section for this?  Or add comments
to the configure.ac section.  Or both.  For example:

2003-11-24  Paul Eggert  <address@hidden>

        * modules/unlocked-io: Add comments about USE_UNLOCKED_IO.

--- unlocked-io.~1.4.~  Fri Aug  8 13:15:52 2003
+++ unlocked-io Mon Nov 24 13:01:09 2003
@@ -1,5 +1,7 @@
 Description:
 Enable faster, non-thread-safe stdio functions if available.
+The default is suitable for unithreaded applications; packages with
+multithreaded applications should also invoke AC_DEFINE([USE_UNLOCKED_IO], 0).
 
 Files:
 lib/unlocked-io.h
@@ -10,6 +12,7 @@ extensions
 
 configure.ac:
 jm_FUNC_GLIBC_UNLOCKED_IO
+# AC_DEFINE([USE_UNLOCKED_IO], 0) # for packages with multithreaded 
applications
 
 Makefile.am:
 lib_SOURCES += unlocked-io.h