[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 293/324: README.org: Remove things documented in the man
From: |
gnunet |
Subject: |
[gnunet-scheme] 293/324: README.org: Remove things documented in the manual. |
Date: |
Tue, 21 Sep 2021 13:25:33 +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 8c3e2e304605fb3f001fc0553e6495b9b59f1924
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Mon Sep 13 21:01:42 2021 +0200
README.org: Remove things documented in the manual.
* README.org
(Message queues, List of errors, Configuration, Network structures)
(GNUnet network structures, network size estimation): Delete.
* gnu/gnunet/mq.scm (make-message-queue): Remove reference to
README.org, point to the manual instead.
---
README.org | 117 ------------------------------------------------------
gnu/gnunet/mq.scm | 2 +-
2 files changed, 1 insertion(+), 118 deletions(-)
diff --git a/README.org b/README.org
index 792d221..c09a091 100644
--- a/README.org
+++ b/README.org
@@ -76,118 +76,6 @@ to doc/scheme-gnunet.tm.
+ wart: these modules have some ‘unniceties’ (warts). This does /not/
prevent
the ‘good’ tag.
-** Message queues :test:good:
-
- Message queues have a handler for normal incoming messages and for errors.
- If a transport receives an incoming message, it should add it (‘inject’)
- to the incoming messages, which may result in a message handler being
- called. The user of the queue can also try to cancel sending a message
- and will receive a notification when the message cannot be unsent anymore.
-
- Message queues can be used concurrently. (TODO destruction)
-
- + gnu/gnunet/mq/envelope.scm: a wrapper around a message, with a callback
- for cancelling the sending of the message (if not too late) and a callback
- for notifying it cannot be unsent anymore.
- + gnu/gnunet/mq/prio-prefs.scm: message priorities & preferences
-
- Preferences: is out-of-order allowed or not,
- should the message be corked or not ...
- + gnu/gnunet/mq/handler.scm: what to do in
- response to a message.
-
- Different message types may need need different
- capabilities; the interposition can be used to adjust
- the ambient authority appropriately.
- + gnu/gnunet/mq.scm: the message queue itself!
- + gnu/gnunet/mq-impl/stream.scm: generic implementation on top of
- Guile's port abstraction. Use 'connect-unix' to actually connect,
- or 'port->message-queue' to turn an already existing port into a
- message queue.'
-
- Message queue implementations based on streams I/O can use
- (gnu gnunet utils tokeniser), to split the message stream
- into separate messages.
-** List of errors
-
- Not all errors indicate something is wrong.
-
- Input errors
- + input:regular-end-of-file
-
- The end-of-file was encountered and not unexpected
- (compare with input:premature-eof). This means the server
- has closed the connection on the server side.
- + input:premature-end-of-file
-
- The end-of-file was encountered, but unexpected.
- More specifically, a message was being read.
- + input:overly-small type size
-
- The message size in the header was smaller than the minimal
- message size.
-
- Connection errors:
- + connection:connected
-
- The message queue has been connected,
- so sent messages shouldn't simply be buffered.
- Injected by (gnu gnunet mq-impl stream).
- + connection:interrupted
-
- The message queue has been closed before the connection could
- be established. Injected by (gnu gnunet mq-impl stream).
-
- Input errors (decoding)
- + logic:no-handler type . rest
- No handler for received message type (rest is currently unspecified)
- + logic:ill-formed type . rest
- Message is invalid according to message handler (rest is currently
- unspecified)
-** 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
- + gnu/gnunet/config/db.scm: Quaject for configurations.
-
- TODO: modifying, update notifications, loading ...
-** Network structures :good:wart:
- Features:
-
- + structures are always architecture-independent
- (no possible dependencies on the C ABI)
- + big / little endianness distinction
- + (almost) no runtime overhead over raw
- slice-u8-ref & friends when using syntax API
-
- (Some overhead is incurred due to type-checking)
- TODO: verify expanded code
- + structures can have various meta data
- (e.g. docstring) TODO write emacs functions
- for looking up docstrings etc.
-
- Not features (in contrast with scheme-bytestructures):
- - not extensible with new kinds of network structure types.
-
- How to use:
- + define network structures in a (... struct) module
- using (gnu gnunet netstruct syntactic) or
- (gnu gnunet netstruct procedural)
- + use network structures /outside/ the (... struct) module
- using (gnu gnunet netstruct syntactic)
- or (gnu gnunet netstruct procedural) module.
-
- The former is preferred as offsets and sizes etc.
- are inlined
-
- TODO: make sure no references to (... struct) modules
- are created when accessing network structures with
- (gnu gnunet netstruct syntactic).
-** GNUnet network structures :good:
- + 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, ... :test:good:why:
+ gnu/gnunet/icmp/struct.scm: ICMP packet types & codes
(incomplete, to be used for error messages)
@@ -199,11 +87,6 @@ to doc/scheme-gnunet.tm.
TODO: nice abstraction for network errors
** Relative time manipulation :test:good:
+ gnu/gnunet/time.scm: Time units and exponential back-off.
-** Network size estimation :test:good:wart:
- + gnu/gnunet/nse/client.scm: API for the network size estimation
- service. Doesn't currently support automatic reconnection.
- + gnu/gnunet/nse/struct.scm: Network structures for the network size
- estimation service.
* Conventions
** Fibers, capabilities and ambient authority
Modules are expected to use ‘fibers’ for concurrency.
diff --git a/gnu/gnunet/mq.scm b/gnu/gnunet/mq.scm
index 73528b9..5cecae8 100644
--- a/gnu/gnunet/mq.scm
+++ b/gnu/gnunet/mq.scm
@@ -120,7 +120,7 @@ messages are not serialised. As such, some synchronisation
or punting
messages onto a separate thread may be necessary.
Injected errors are passed to @var{error-handler}, a variadic procedure.
-A list of possible errors can be found in @file{README.org}.
+A list of possible errors can be found in the manual.
Messages are sent with @var{sender}. It can be created with
@code{make-one-by-one-sender}. Optionally, a @var{closer} procedure can
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet-scheme] 281/324: config: Implement loading a configuration file., (continued)
- [gnunet-scheme] 281/324: config: Implement loading a configuration file., gnunet, 2021/09/21
- [gnunet-scheme] 284/324: config: Automatically load defaults, system and user configuration., gnunet, 2021/09/21
- [gnunet-scheme] 282/324: config: Allow expanding loaded configurations., gnunet, 2021/09/21
- [gnunet-scheme] 285/324: examples: Distribute the example., gnunet, 2021/09/21
- [gnunet-scheme] 289/324: guix: Set up .guix-authorizations., gnunet, 2021/09/21
- [gnunet-scheme] 288/324: ROADMAP.org: Mark resolved TODO's as DONE., gnunet, 2021/09/21
- [gnunet-scheme] 295/324: tests/network-size: Remove resolved XXX., gnunet, 2021/09/21
- [gnunet-scheme] 304/324: doc: Don't suggest Scheme-GNUnet has any applications., gnunet, 2021/09/21
- [gnunet-scheme] 306/324: README.org: Really point to doc/scheme-gnunet.tm., gnunet, 2021/09/21
- [gnunet-scheme] 308/324: doc: Remove TODO about mailing lists., gnunet, 2021/09/21
- [gnunet-scheme] 293/324: README.org: Remove things documented in the manual.,
gnunet <=
- [gnunet-scheme] 301/324: doc: Note a custom guile-fibers and guile is required., gnunet, 2021/09/21
- [gnunet-scheme] 300/324: doc: Move contact information to .tm documentation (and rewrite)., gnunet, 2021/09/21
- [gnunet-scheme] 296/324: RAEDME.org: Remove wishlist., gnunet, 2021/09/21
- [gnunet-scheme] 294/324: doc: Document tests in doc/scheme-gnunet.tm., gnunet, 2021/09/21
- [gnunet-scheme] 312/324: configure.ac: Set bug reporting address., gnunet, 2021/09/21
- [gnunet-scheme] 314/324: guix: Don't include a copy of guile-quickcheck., gnunet, 2021/09/21
- [gnunet-scheme] 316/324: doc: Split into pages., gnunet, 2021/09/21
- [gnunet-scheme] 290/324: doc: Document how to authenticate new source code., gnunet, 2021/09/21
- [gnunet-scheme] 299/324: README.org: Remove ‘Conventions’., gnunet, 2021/09/21
- [gnunet-scheme] 305/324: README.org: Remove LICENSE section., gnunet, 2021/09/21