Hi Bruno,

Bruno Haible <br...@clisp.org> writes:

> Collin Funk wrote:
>> Perhaps there should be an extra status for test modules that should
>> generally be excluded.
>
> I was thinking in the same direction. The 'Status' is already taken (it is
> 'deprecated' for some of the relevant modules). Therefore, I'm adding a new
> piece of meta-information.

Yes, I was thinking of an extra value for the 'Status' field. But that
one has too many values already (see 'obsolete' vs. 'deprecated'
discussion awhile ago). Therefore I think your idea is better.

I've added a small mention in the documentation to make it official.

Collin

>From 15d0addc284cf2fddb4eb1f6270838545974af04 Mon Sep 17 00:00:00 2001
From: Collin Funk <collin.fu...@gmail.com>
Date: Sun, 28 Jul 2024 18:20:06 -0700
Subject: [PATCH] doc: Document the 'Useable-in-testdir' field in module
 descriptions.

* doc/gnulib.texi (Module description): Add the 'Usable-in-testdir'
field.
---
 ChangeLog       | 6 ++++++
 doc/gnulib.texi | 4 ++++
 2 files changed, 10 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 7c19352aae..0974283d46 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-07-28  Collin Funk  <collin.fu...@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  <br...@clisp.org>
 
 	gnulib-tool.py: New options --extract-[recursive-]dependents.
diff --git a/doc/gnulib.texi b/doc/gnulib.texi
index 40aed018e2..3f2d1ee44d 100644
--- a/doc/gnulib.texi
+++ b/doc/gnulib.texi
@@ -411,6 +411,10 @@ @node Module description
 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
-- 
2.45.2

Reply via email to