]> Savannah Git Hosting - gnulib.git/commitdiff
doc: Omit internal modules from the "Undocumented modules" index.
authorBruno Haible <bruno@clisp.org>
Sun, 29 Dec 2024 17:16:27 +0000 (18:16 +0100)
committerBruno Haible <bruno@clisp.org>
Sun, 29 Dec 2024 17:16:27 +0000 (18:16 +0100)
* doc/internal-modules: New file.
* doc/Makefile (undocumented-modules.texi): Filter out the internal
modules.

ChangeLog
doc/Makefile
doc/internal-modules [new file with mode: 0644]

index 20160a9c3f3b0f71fa5ecb8863aa72e3dc36a566..493f3e0dab9745b6c3e2a8aaa3e8640492942622 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2024-12-29  Bruno Haible  <bruno@clisp.org>
+
+       doc: Omit internal modules from the "Undocumented modules" index.
+       * doc/internal-modules: New file.
+       * doc/Makefile (undocumented-modules.texi): Filter out the internal
+       modules.
+
 2024-12-28  Collin Funk  <collin.funk1@gmail.com>
 
        doc: Add missing module index.
index 343419f44a75b420a0638b5f7e22434b2f2a76d4..c7e505a6de35fc12020656705cbf7746d311ecca 100644 (file)
@@ -27,8 +27,10 @@ undocumented-modules.texi: force
        LC_ALL=C join -v1 all-modules.tmp documented-modules.tmp > undocumented-modules.tmp
 # For testing whether a module is deprecated, "./gnulib-tool --extract-status <module>" is a bit slow, so use grep instead.
        modules=`cat undocumented-modules.tmp`; (cd ../modules && grep -l '^deprecated$$' $$modules) > deprecated-undocumented-modules.tmp
-       LC_ALL=C join -v1 undocumented-modules.tmp deprecated-undocumented-modules.tmp | sed -e 's/^/@umindex /' > undocumented-modules.texi
-       rm -f documented-modules.tmp all-modules.tmp undocumented-modules.tmp deprecated-undocumented-modules.tmp
+       LC_ALL=C join -v1 undocumented-modules.tmp deprecated-undocumented-modules.tmp > undocumented-modules-2.tmp
+       LC_ALL=C join -v1 undocumented-modules-2.tmp internal-modules > undocumented-modules-3.tmp
+       sed -e 's/^/@umindex /' < undocumented-modules-3.tmp > undocumented-modules.texi
+       rm -f documented-modules.tmp all-modules.tmp undocumented-modules.tmp deprecated-undocumented-modules.tmp undocumented-modules-2.tmp undocumented-modules-3.tmp
 
 %.info: %.texi undocumented-modules.texi
        $(MAKEINFO) $(manual_opts) $<
diff --git a/doc/internal-modules b/doc/internal-modules
new file mode 100644 (file)
index 0000000..63d0d5f
--- /dev/null
@@ -0,0 +1,78 @@
+# This file lists the modules which are intentionally undocumented
+# because they are internal (i.e. only needed for the purpose of
+# other gnulib modules).
+#
+absolute-header
+at-internal
+dummy
+extensions-aix
+fd-hook
+gen-header
+gen-uni-tables
+glibc-internal/dynarray
+glibc-internal/scratch_buffer
+libc-config
+localename-unsafe
+localename-unsafe-limited
+mixin/printf-gnu
+mixin/printf-posix
+mktime-internal
+openat-die
+posix_spawn-internal
+setlocale-null-unlocked
+snippet/_Noreturn
+snippet/arg-nonnull
+snippet/c++defs
+snippet/link-warning
+snippet/unused-parameter
+snippet/warn-on-use
+socketlib
+strerror-override
+threadlib
+unicase/base
+unicase/cased
+unicase/ignorable
+unicase/special-casing
+unicase/tocasefold
+unicase/u16-casemap
+unicase/u16-is-invariant
+unicase/u32-casemap
+unicase/u32-is-invariant
+unicase/u8-casemap
+unicase/u8-is-invariant
+uniconv/base
+unictype/category-none
+unigbrk/base
+unilbrk/base
+unilbrk/tables
+unilbrk/ulc-common
+unimetadata/base
+unimetadata/u-version
+uniname/base
+uninorm/compat-decomposition
+uninorm/decompose-internal
+uninorm/decomposition-table
+unistdio/base
+unistdio/u-printf-args
+unistdio/u16-printf-parse
+unistdio/u32-printf-parse
+unistdio/u8-printf-parse
+unistdio/ulc-printf-parse
+unistr/base
+uniwbrk/base
+uniwbrk/table
+uniwidth/base
+unlocked-io-internal
+windows-cond
+windows-mutex
+windows-once
+windows-recmutex
+windows-rwlock
+windows-spawn
+windows-spin
+windows-stat-override
+windows-thread
+windows-timedmutex
+windows-timedrecmutex
+windows-timedrwlock
+windows-tls