]> Savannah Git Hosting - gnulib.git/commitdiff
doc: Document the 'Useable-in-testdir' field in module descriptions.
authorCollin Funk <collin.funk1@gmail.com>
Mon, 29 Jul 2024 01:20:06 +0000 (18:20 -0700)
committerCollin Funk <collin.funk1@gmail.com>
Mon, 29 Jul 2024 01:20:06 +0000 (18:20 -0700)
* doc/gnulib.texi (Module description): Add the 'Usable-in-testdir'
field.

ChangeLog
doc/gnulib.texi

index 7c19352aae4df497a65f2d5b5197e0902842035d..0974283d46bc081dda6286386d8989ec3282c664 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-07-28  Collin Funk  <collin.funk1@gmail.com>
+
+       doc: Document the 'Useable-in-testdir' field in module descriptions.
+       * doc/gnulib.texi (Module description): Add the 'Usable-in-testdir'
+       field.
+
 2024-07-28  Bruno Haible  <bruno@clisp.org>
 
        gnulib-tool.py: New options --extract-[recursive-]dependents.
index 40aed018e202232e72de2f11b641dd56f8c7cba7..3f2d1ee44d918b8f73161068f5027cd02e899133 100644 (file)
@@ -411,6 +411,10 @@ One sentence is enough.  For example, if it defines a single function
 Gnulib's documentation generator will automatically convert the first part
 to a hyperlink when it has this form.
 
+@item Usable-in-testdir
+This field should contain @samp{no} if the module cannot be used in a
+test directory created with @code{gnulib-tool --create-testdir}.
+
 @item Status
 This field is either empty/absent, or contains the word @samp{obsolete}.  In
 the latter case, @command{gnulib-tool} will, unless the option