Re: [PATCH] hamt: New module.

[Bruno Haible <bruno@clisp.org>]

[-- Attachment #1: Type: text/plain, Size: 856 bytes --]

Hi Marc,

> +	hamt: New module.
> +	This module provides (persistent) hash array mapped tries.
> +	* MODULES.html.sh: Add hamt.
> +	* lib/hamt.c: New file.
> +	* lib/hamt.h: New file.
> +	* modules/hamt: New file.
> +	* modules/hamt-tests: New file.
> +	* tests/test-hamt.c: New file.

Would you like to write a bit of documentation for the Gnulib manual
about it? It does not need to copy the extensive comments in hamt.h.
It need only answer the questions:
  - What is a HAMT?
  - When would I (a programmer) make use of it? How does it compare
    to other container data types?
  - What is the Gnulib module name and the include file name?

I think it would fit into the section "Container data types"
https://www.gnu.org/software/gnulib/manual/html_node/Container-data-types.html .

Find attached the start of a diff to add this documentation.

Bruno

[-- Attachment #2: hamt-doc-start.diff --]
[-- Type: text/x-patch, Size: 722 bytes --]

diff --git a/doc/containers.texi b/doc/containers.texi
index 15c915b..6a9b22e 100644
--- a/doc/containers.texi
+++ b/doc/containers.texi
@@ -35,6 +35,9 @@ log
 Gnulib provides several generic container data types.  They can be used
 to organize collections of application-defined objects.
 
+@node Ordinary containers
+@subsection Ordinary container data types
+
 @multitable @columnfractions .15 .5 .1 .1 .15
 @headitem Data type
 @tab Details
@@ -599,6 +602,11 @@ For C++, Gnulib provides a C++ template class for each of these container data t
 @tab @code{"gl_omap.hh"}
 @end multitable
 
+@node Specialized containers
+@subsection Specialized container data types
+
+HAMT ...
+
 @ifnottex
 @unmacro log
 @end ifnottex