[gnunet-scheme] 02/04: doc: Promote sections to chapters.

[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 9da2e0d21b029f4b5915eb26f7b8153b45b64bd6
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Thu Feb 3 09:42:18 2022 +0000

    doc: Promote sections to chapters.
    
    Fixes: <https://notabug.org/maximed/scheme-gnunet/issues/14>.
---
 doc/scheme-gnunet.tm | 40 ++++++++++++++++++----------------------
 1 file changed, 18 insertions(+), 22 deletions(-)

diff --git a/doc/scheme-gnunet.tm b/doc/scheme-gnunet.tm
index 8b7caf0..159c3a6 100644
--- a/doc/scheme-gnunet.tm
+++ b/doc/scheme-gnunet.tm
@@ -332,9 +332,7 @@
   we hope we have something to write here, but for now, this chapter is
   empty.
 
-  <chapter|Programming guide>
-
-  <section|Concurrency>
+  <chapter|Concurrency>
 
   Scheme-GNUnet uses <code*|guile-fibers> for concurrency, but supports
   POSIX-style threading as well, using the <code*|(ice-9 threads)> Guile
@@ -350,7 +348,7 @@
   <scm|(gnu gnunet concurrency repeated-condition)>.<space|1em>It is
   unfortunately ill-documented.
 
-  <section|Configuration>
+  <chapter|Configuration>
 
   There are a number of modules for accessing GNUnet
   configurations.<space|1em>Firstly, there is <scm|(gnu gnunet config db)>,
@@ -414,7 +412,7 @@
     ;; \ \ \ \ \ \ key: "MAX_ROUTES"
   </scm-code>
 
-  <subsection|Locating configuration files>
+  <section|Locating configuration files>
 
   There are two \U possibly non-existent \U configuration files: the
   <with|font-shape|italic|user> configuration and the
@@ -464,7 +462,7 @@
     Currently, this is always <verbatim|/etc/gnunet.conf>.
   </explain>
 
-  <subsection|Loading configuration files>
+  <section|Loading configuration files>
 
   Once the location of the configuration file is known, the file can be
   opened with the Scheme procedure <scm|open-input-file>, which returns an
@@ -513,7 +511,7 @@
   Applications (whether graphical or textual) are recommended to use
   <scm|load-configuration> by default, as it largely just works.
 
-  <section|Manipulation of network structures>
+  <chapter|Manipulation of network structures>
 
   <index|network structure><index|netstruct>The modules <scm|(gnu gnunet
   netstruct procedural)> and <scm|(gnu gnunet netstruct syntactic)> can be
@@ -574,7 +572,7 @@
   149>, \ interpreted as an IEEE double, form the number
   <math|19.93\<ldots\>>.
 
-  <subsection|Documentation>
+  <section|Documentation>
 
   A network structure can optionally have embedded
   documentation.<space|1em>More specifically, network structures can
@@ -591,7 +589,7 @@
   with <scm|structure/packed> and individual fields and can be accessed with
   the procedures <scm|documentation>, <scm|synopsis> and <scm|properties>.
 
-  <subsection|Reading and writing>
+  <section|Reading and writing>
 
   The procedures <scm|read%><index|read%>, <scm|set%!><index|set%!>,
   <scm|sizeof><index|sizeof> and <scm|select><index|select> from <scm|(gnu
@@ -664,7 +662,7 @@
     (read% /:msg:nse:estimate/example '(size-estimate) message) ; 19.2
   </scm-code>
 
-  <subsection|Primitive types>
+  <section|Primitive types>
 
   There are a number of pre-defined types.<space|1em>First, there is
   <scm|u8>, a single octet that is interpreted as an integer in the closed
@@ -676,12 +674,12 @@
   and represent floating-point numbers in IEEE 754 format
   (\<#2018\>binary64\<#2019\>).
 
-  <subsection|Packing>
+  <section|Packing>
 
   In contrast to C structures, Scheme-GNUnet network structures are always
   packed \V there are no \<#2018\>gaps\<#2019\> between fields.
 
-  <section|Communication with services>
+  <chapter|Communication with services>
 
   To connect with a GNUnet service \V this applies to both the C and Scheme
   implementation, the GNUnet service must bind a local domain
@@ -696,7 +694,7 @@
     (define mq (connect/fibers config "nse" handlers error-handler))
   </scm-code>
 
-  <subsection|Asynchronuously connecting>
+  <section|Asynchronuously connecting>
 
   This is an asynchronuous operation: it will \<#2018\>complete\<#2019\>
   immediately and the connection will actually be formed in the
@@ -726,7 +724,7 @@
     \ \ (connect/fibers config "nse" (message-handlers) error-handler))
   </scm-code>
 
-  <subsection|Message handler>
+  <section|Message handler>
 
   <index|message handler>When a message is received by the message queue, the
   corresponding message handler is invoked.<space|1em>Message handlers can be
@@ -812,7 +810,7 @@
 
   <todo|document the message type database, various procedures>
 
-  <subsection|Message type database>
+  <section|Message type database>
 
   The module <scm|(gnu gnunet message protocols)> has a mapping of symbolic
   names of every message type known to scheme-GNUnet to their numeric
@@ -832,7 +830,7 @@
 
   <todo|how to define new message types>
 
-  <subsection|Error handler>
+  <section|Error handler>
 
   The message queue implementation usually just sends and receives messages,
   but some exceptional situations cannot be communicated with
@@ -905,7 +903,7 @@
   application.<space|1em>To report errors, see the section
   <reference|sec:error reporting> Error reporting.
 
-  <subsection|Ordering of injected errors and messages and sent messages>
+  <section|Ordering of injected errors and messages and sent messages>
 
   This section describes how injected errors and messages and sent messages
   are ordered with respect to each other in the default message queue
@@ -955,7 +953,7 @@
 
   <todo|envelopes>
 
-  <subsection|Disconnecting>
+  <section|Disconnecting>
 
   A message queue can be closed with the <scm|close-queue!> procedure from
   <scm|(gnu gnunet mq)>.<space|1em>In the default message queue
@@ -985,7 +983,7 @@
   Error messages are translated for the current locale.<todo|TODO actually
   call bindtextdomain>
 
-  <section|Estimation of the size of the network>
+  <chapter|Estimation of the size of the network>
 
   <index|network size estimation>GNUnet has a service that roughly estimates
   the size of the network \U i.e., the number of peers.<space|1em>The module
@@ -1305,9 +1303,7 @@
     <var|to> and return it.
   </explain>
 
-  <chapter|Implementation details>
-
-  TODO<appendix|GNU Free Documentation License>
+  <appendix|GNU Free Documentation License>
 
   <include|fdl.tm>
 

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