[gnunet-scheme] branch master updated (a40d7b9 -> 6853e82)

[gnunet]

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

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

    from a40d7b9  configure.ac: Test for required Guile libraries.
     new 0f534a2  Remove unused patch guile-fibers-epoll-instance-is-dead.patch.
     new ed917db  doc/cadet: Make warning more precise.
     new 07145ae  doc: Fix cross-references to DHT and NSE connect.
     new 6a6ce51  doc: Fix CADET-related cross-references.
     new 6853e82  doc: Fix cross-reference from NSE to configuration.

The 5 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 doc/cadet.tm                              | 10 ++--
 doc/configuration.tm                      | 13 ++--
 doc/distributed-hash-table.tm             |  2 +-
 doc/network-size-estimation.tm            | 13 ++--
 doc/service-communication.tm              |  7 ++-
 guile-fibers-epoll-instance-is-dead.patch | 99 -------------------------------
 6 files changed, 25 insertions(+), 119 deletions(-)
 delete mode 100644 guile-fibers-epoll-instance-is-dead.patch

diff --git a/doc/cadet.tm b/doc/cadet.tm
index 7517b3b..d7b93e4 100644
--- a/doc/cadet.tm
+++ b/doc/cadet.tm
@@ -14,7 +14,9 @@
   background on CADET's capabilities is given.
 
   <\warning>
-    To be implemented, this is a draft of the API!
+    The API is not yet complete (listening is not yet supported) and some
+    aspects (reconnecting, garbage collection) are unimplemented or untested.
+    This is expected to improve in the future.
   </warning>
 
   <section|Qualities and limitations \V avoiding reinventing the wheel>
@@ -103,9 +105,9 @@
 
   To actually send and receive messages, the
   <scm|channel-message-queue><index|channel-message-queue> can be used to
-  retrieve the <em|message queue> (see: <reference|message queue>) of the
-  channel and the procedure <scm|send-message!> can be used to send the
-  message to the message queue (see: <reference|send-message!>).
+  retrieve the <em|<reference|message queue>> of the channel and the
+  procedure <scm|<reference|send-message!>> can be used to send the message
+  to the message queue.
 
   When done with the channel, it should be <dfn|closed>, to save resources.
   This is done with <scm|>the procedure 
<scm|close-channel!><index|close-channel!>:
diff --git a/doc/configuration.tm b/doc/configuration.tm
index 3ac8261..b86ed42 100644
--- a/doc/configuration.tm
+++ b/doc/configuration.tm
@@ -6,12 +6,13 @@
 
 <\body>
   There are a number of modules for accessing GNUnet
-  configurations<index|configuration>.<space|1em>Firstly, there is <scm|(gnu
-  gnunet config db)><index|(gnu gnunet config db)>, which is the module
-  library code would typically use.<space|1em>For testing, one can create an
-  empty configuration with the procedure 
<scm|hash-\<gtr\>configuration><index|hash-\<gtr\>configuration>
-  from that module and <scm|make-hashtable> from <scm|(rnrs hashtables)>,
-  using <scm|hash-key><index|hash-key> as hash function and
+  configurations<index|configuration><label|configuration>.<space|1em>Firstly,
+  there is <scm|(gnu gnunet config db)><index|(gnu gnunet config db)>, which
+  is the module library code would typically use.<space|1em>For testing, one
+  can create an empty configuration with the procedure
+  <scm|hash-\<gtr\>configuration><index|hash-\<gtr\>configuration> from that
+  module and <scm|make-hashtable> from <scm|(rnrs hashtables)>, using
+  <scm|hash-key><index|hash-key> as hash function and
   <scm|key=?><index|key=?> as comparison function:
 
   <\scm-code>
diff --git a/doc/distributed-hash-table.tm b/doc/distributed-hash-table.tm
index 8c57e5d..16f8656 100644
--- a/doc/distributed-hash-table.tm
+++ b/doc/distributed-hash-table.tm
@@ -14,7 +14,7 @@
 
   <\explain>
     <scm|(connect <var|config> <var|#:connected> <var|#:disconnected>
-    <var|#:spawn>)><subindex|connect|DHT>
+    <var|#:spawn>)><subindex|connect|DHT><label|dht:connect>
   <|explain>
     Connect to the DHT service, using the configuration <var|config>. The
     connection is made asynchronuously; the optional thunk <var|connected> is
diff --git a/doc/network-size-estimation.tm b/doc/network-size-estimation.tm
index 1d5556c..9167a27 100644
--- a/doc/network-size-estimation.tm
+++ b/doc/network-size-estimation.tm
@@ -9,13 +9,12 @@
   estimates the size of the network \U i.e., the number of
   peers.<space|1em>The module <scm|(gnu gnunet nse client)><index|(gnu gnunet
   nse client)> can be used to interact with this service.<space|1em>The
-  connection is made with the procedure <scm|connect><subindex|connect|NSE>,
-  which is accepts a <with|font-shape|italic|configuration> (see
-  <todo|reference>) and some optional keyword arguments.<space|1em>This
-  procedure can be called as <scm|(connect config #:updated updated
-  #:connected connected #:disconnected disconnected)>.<space|1em>It returns a
-  <with|font-shape|italic|NSE server object><index|NSE server
-  object><subindex|server object|NSE>.
+  connection is made with the procedure 
<scm|connect><subindex|connect|NSE><label|nse:connect>,
+  which is accepts a <em|<reference|configuration>> and some optional keyword
+  arguments.<space|1em>This procedure can be called as <scm|(connect config
+  #:updated updated #:connected connected #:disconnected
+  disconnected)>.<space|1em>It returns a <with|font-shape|italic|NSE server
+  object><index|NSE server object><subindex|server object|NSE>.
 
   The connection is made asynchronuously; the thunk <var|connected> will be
   called when the connection has actually been made.<space|1em>Whenever a new
diff --git a/doc/service-communication.tm b/doc/service-communication.tm
index 3ed9e8f..4dabe0c 100644
--- a/doc/service-communication.tm
+++ b/doc/service-communication.tm
@@ -19,6 +19,9 @@
     (define mq (connect/fibers config "nse" handlers error-handler))
   </scm-code>
 
+  The returned object <var|mq> is named a <dfn|message queue><index|message
+  queue><label|message queue>.
+
   <section|Asynchronuously connecting><index|connecting to services>
 
   This is an asynchronuous operation: it will \<#2018\>complete\<#2019\>
@@ -162,7 +165,7 @@
 
   <section|Sending messages>
 
-  Messages can be sent with the <scm|send-message!><index|send-message!>
+  Messages can be sent with the 
<scm|send-message!><index|send-message!><label|send-message!>
   procedure, which can be called as <scm|(send-message! <var|mq>
   <var|message> #:priority <var|priority>)>, where <var|mq> is the message
   queue and <var|message> is the message to send as a readable bytevector
@@ -388,7 +391,7 @@
     required for generating the configuration file. <var|connect> is a
     procedure that can be called as <scm|(connect config #:spawn _
     #:connected _ #:disconnected _>), such as the <scm|connect> procedure
-    from (<todo|reference to DHT or NSE>.
+    from DHT <reference|dht:connect> and NSE <reference|nse:connect>.
 
     This procedure returns a boolean value suitable for <scm|test-assert>.
   </explain>
diff --git a/guile-fibers-epoll-instance-is-dead.patch 
b/guile-fibers-epoll-instance-is-dead.patch
deleted file mode 100644
index ba191f7..0000000
--- a/guile-fibers-epoll-instance-is-dead.patch
+++ /dev/null
@@ -1,99 +0,0 @@
-From 5db4077e9f5166033637d2af9532ec6144b85646 Mon Sep 17 00:00:00 2001
-From: Maxime Devos <maximedevos@telenet.be>
-Date: Thu, 30 Jun 2022 14:21:47 +0000
-Subject: [PATCH 1/2] Fix behaviour of 'epoll-wake!' after 'run-fibers'.
-
-This avoids the "epoll instance is dead" error noticed in
-GNUnet-Scheme's test suite, as reported at
-<https://github.com/wingo/fibers/issues/61>.
-A test is added in the next commit.
-
-This patch has been applied upstream, but there hasn't been
-a new release yet at time of writing.
-
-* fibers/epoll.scm (epoll-wake!)[dead]: Instead of throwing an error,
-just return #t.
----
- fibers/epoll.scm | 8 +++++++-
- 1 file changed, 7 insertions(+), 1 deletion(-)
-
-diff --git a/fibers/epoll.scm b/fibers/epoll.scm
-index d26db4d..eb63242 100644
---- a/fibers/epoll.scm
-+++ b/fibers/epoll.scm
-@@ -1,6 +1,7 @@
- ;; epoll
- 
- ;;;; Copyright (C) 2016 Andy Wingo <wingo@pobox.com>
-+;;;; Copyright (C) 2022 Maxime Devos <maximedevos@telenet.be>
- ;;;; 
- ;;;; This library is free software; you can redistribute it and/or
- ;;;; modify it under the terms of the GNU Lesser General Public
-@@ -135,7 +136,12 @@ epoll wait (if appropriate)."
-     ('waiting
-      (primitive-epoll-wake (fileno (epoll-wake-write-pipe epoll))))
-     ('not-waiting #t)
--    ('dead (error "epoll instance is dead"))))
-+    ;; This can happen if a fiber was waiting on a condition and
-+    ;; run-fibers completes before the fiber completes and afterwards
-+    ;; the condition is signalled.  In that case, we don't have to
-+    ;; resurrect the fiber or something, we can just do nothing.
-+    ;; (Bug report: https://github.com/wingo/fibers/issues/61)
-+    ('dead #t)))
- 
- (define (epoll-default-folder fd events seed)
-   (acons fd events seed))
-
-From c01d3853eb56ea4adacc31f51f6e917f8c0abe1c Mon Sep 17 00:00:00 2001
-From: Maxime Devos <maximedevos@telenet.be>
-Date: Thu, 30 Jun 2022 14:18:36 +0000
-Subject: [PATCH 2/2] Test for issue #61.
-
-* tests/conditions.scm: Add a test.
----
- tests/conditions.scm | 20 ++++++++++++++++++++
- 1 file changed, 20 insertions(+)
-
-diff --git a/tests/conditions.scm b/tests/conditions.scm
-index 505c42a..179605a 100644
---- a/tests/conditions.scm
-+++ b/tests/conditions.scm
-@@ -1,6 +1,7 @@
- ;; Fibers: cooperative, event-driven user-space threads.
- 
- ;;;; Copyright (C) 2016 Free Software Foundation, Inc.
-+;;;; Copyright (C) 2022 Maxime Devos <maximedevos@telenet.be>
- ;;;;
- ;;;; This library is free software; you can redistribute it and/or
- ;;;; modify it under the terms of the GNU Lesser General Public
-@@ -21,6 +22,7 @@
-   #:use-module (fibers)
-   #:use-module (fibers conditions)
-   #:use-module (fibers operations)
-+  #:use-module (fibers scheduler)
-   #:use-module (fibers timers))
- 
- (define failed? #f)
-@@ -78,4 +80,22 @@
-                              (wait cv)
-                              #t))
- 
-+;; Make a condition, wait for it inside a fiber, let the fiber abruptly
-+;; terminate and signal the condition afterwards.  This tests for the bug
-+;; noticed at <https://github.com/wingo/fibers/issues/61>.
-+(assert-equal #t
-+            (let ((cv (make-condition)))
-+              (run-fibers
-+               (lambda ()
-+                 (spawn-fiber (lambda () (wait cv)))
-+                 (yield-current-task)) ; let the other fiber wait forever
-+               ;; This test relies on not draining -- this is the default,
-+               ;; but let's make this explicit.
-+               #:drain? #false ;
-+               ;; For simplicity, disable concurrency and preemption.
-+               ;; That way, we can use 'yield-current-task' instead of an
-+               ;; arbitrary sleep time.
-+               #:hz 0 #:parallelism 1)
-+              (signal-condition! cv)))
-+
- (exit (if failed? 1 0))

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