[gnunet-scheme] 106/324: doc: Classify modules.

[gnunet]

This is an automated email from the git hooks/post-receive script.

maxime-devos pushed a commit to branch master
in repository gnunet-scheme.

commit 4b5e51aad78b71a732a24cf5342367610fa9ab73
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Sun Apr 11 11:23:15 2021 +0200

    doc: Classify modules.
    
    * README.org (Message queues): Add a section ‘Tags’ and tag modules
      according to whether they are known to be practical, whether they
      are tested, whether they will likely see any use ...
---
 README.org | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/README.org b/README.org
index 915b22c..1e5b432 100644
--- a/README.org
+++ b/README.org
@@ -52,8 +52,17 @@
     can be waited upon.
   + gnu/gnunet/utils/platform-enum.scm: Platform-specific
     C-style enum values.
-
-** Message queues
+** Tags
+   + spec: it is unknown if this will turn out to be a practical abstraction.
+   + why: it remains to be seen if these modules will have any use
+   + test: these modules have (passing) tests
+   + good: these modules, abstractions ... are practical, and will not be 
scrapped
+     (tweaks might still be possible, and the modules could still have missing
+     functionality)
+   + wart: these modules have some ‘unniceties’ (warts).  This does /not/ 
prevent
+     the ‘good’ tag.
+
+** Message queues                                                      :spec:
    Message queues have three parts: the input queue, the output
    queue and the transport, that are respectively a read+close request
    capability, a write+close request capability and a capability
@@ -73,14 +82,14 @@
      fibers channels and for messages.
    + TODO actual queues?  Maybe we don't need them?
    + TODO filling the queues
-** Configuration
+** Configuration                                                  :test:good:
    + gnu/gnunet/config/parser.scm: Parse configuration files.
    + gnu/gnunet/config/expand.scm: Perform variable expansion.
    + gnu/gnunet/config/value-parser.scm: Parse configuration values.
      TODO: value->data, value->relative-time
 
    TODO: writing, modifying, querying ...
-** Network structures
+** Network structures                                             :good:wart:
    Features:
 
    + structures are always architecture-independent
@@ -112,12 +121,12 @@
      TODO: make sure no references to (... struct) modules
      are created when accessing network structures with
      (gnu gnunet netstruct syntactic).
-** GNUnet network structures
+** GNUnet network structures                                           :good:
    + gnu/gnunet/nse/struct.scm: network size estimation
    + gnu/gnunet/hashcode/struct.scm: hashes
    + gnu/gnunet/crypto/struct.scm: signatures, keys, nonces ...
    + gnu/gnunet/util/struct.scm: various things
-** More refined IP, TCP, UDP, ...
+** More refined IP, TCP, UDP, ...                             :test:good:why:
    + gnu/gnunet/icmp/struct.scm: ICMP packet types & codes
      (incomplete, to be used for error messages)
    + gnu/gnunet/util/cmsg.scm: Constructing & analysing

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.