[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 106/324: doc: Classify modules.
From: |
gnunet |
Subject: |
[gnunet-scheme] 106/324: doc: Classify modules. |
Date: |
Tue, 21 Sep 2021 13:22:26 +0200 |
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.
- [gnunet-scheme] 82/324: Implement self-documenting ‘network structures’, (continued)
- [gnunet-scheme] 82/324: Implement self-documenting ‘network structures’, gnunet, 2021/09/21
- [gnunet-scheme] 88/324: mq: Move message queue modules to (gnu gnunet mq SOMETHING)., gnunet, 2021/09/21
- [gnunet-scheme] 101/324: utils: hat-let: Add <--, a variant on <-., gnunet, 2021/09/21
- [gnunet-scheme] 89/324: doc: Document current list of defined GNUnet network structures., gnunet, 2021/09/21
- [gnunet-scheme] 94/324: bv-slice: Correct offset calculation in slice-slice., gnunet, 2021/09/21
- [gnunet-scheme] 98/324: utils: Define module for defining platform-specifing enumerations., gnunet, 2021/09/21
- [gnunet-scheme] 95/324: util: Allow splitting and constructing ancillary messages., gnunet, 2021/09/21
- [gnunet-scheme] 103/324: config: parser: parse ${variable} expansions., gnunet, 2021/09/21
- [gnunet-scheme] 105/324: config: value-parser: Parse values in configuration files., gnunet, 2021/09/21
- [gnunet-scheme] 107/324: tests: message-io: Unbreak., gnunet, 2021/09/21
- [gnunet-scheme] 106/324: doc: Classify modules.,
gnunet <=
- [gnunet-scheme] 120/324: netstruct syntactic: Fix error when field is constant., gnunet, 2021/09/21
- [gnunet-scheme] 121/324: netstruct: Correct argument order to slice-uN-set!., gnunet, 2021/09/21
- [gnunet-scheme] 113/324: hat-let: Avoid having to import '_' from (rnrs base)., gnunet, 2021/09/21
- [gnunet-scheme] 112/324: config: parser: Fix typo in documentation., gnunet, 2021/09/21
- [gnunet-scheme] 93/324: doc: Some tips on testing., gnunet, 2021/09/21
- [gnunet-scheme] 104/324: config: Implement variable expansion., gnunet, 2021/09/21
- [gnunet-scheme] 129/324: netstruct: New promised tests., gnunet, 2021/09/21
- [gnunet-scheme] 99/324: config: Parse configuration lines into one of several types., gnunet, 2021/09/21
- [gnunet-scheme] 115/324: hat-let: Drop incorrect copyright notices., gnunet, 2021/09/21
- [gnunet-scheme] 125/324: netstruct: Only select the relevant part for writing., gnunet, 2021/09/21