commit c0e1c1d1cc7531130ba9de8e74520fd21c3aa574
parent 7354039a54210598970aa214ff08a29b7d4bc35e
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Fri, 21 Oct 2022 11:39:13 +0900
fix warnings wrt index for texinfo
Diffstat:
19 files changed, 51 insertions(+), 26 deletions(-)
diff --git a/developers/contributing.rst b/developers/contributing.rst
@@ -7,7 +7,8 @@ Contributing
.. _Licenses-of-contributions:
:index:`Licenses of contributions <single: licenses; of contributions>`
-=======================================================================
+Licenses of contributions
+=========================
GNUnet is a `GNU <https://www.gnu.org/>`__ package. All code
contributions must thus be put under the `GNU Affero Public License
@@ -26,7 +27,8 @@ adhered to.
.. _Copyright-Assignment:
:index:`Copyright Assignment <single: copyright; assignment>`
-=============================================================
+Copyright Assignment
+====================
.. todo:: Link to copyright assignment.
diff --git a/developers/subsystems/cadet/cadet.rst b/developers/subsystems/cadet/cadet.rst
@@ -46,7 +46,8 @@ properties that make it a more universal service than CORE.
network are able to process.
:index:`libgnunetcadet <single: libgnunet; cadet>`
---------------------------------------------------
+libgnunetcadet
+--------------
The CADET API (defined in ``gnunet_cadet_service.h``) is the messaging
API used by P2P applications built using GNUnet. It provides
diff --git a/developers/subsystems/core/core.rst b/developers/subsystems/core/core.rst
@@ -40,7 +40,8 @@ then adds fundamental security to the connections:
.. _Limitations:
:index:`Limitations <CORE; limitations>`
-----------------------------------------
+Limitations
+-----------
CORE does not perform
`routing <http://en.wikipedia.org/wiki/Routing>`__; using CORE it is
@@ -106,7 +107,8 @@ applications about the new connection.
:index:`libgnunetcore <libgnunet; core>`
-----------------------------------------
+libgnunetcore
+-------------
The CORE API (defined in ``gnunet_core_service.h``) is the basic
messaging API used by P2P applications built using GNUnet. It provides
diff --git a/developers/subsystems/dht/dht.rst b/developers/subsystems/dht/dht.rst
@@ -148,7 +148,8 @@ results from this primitive implementation.
libgnunetdht
:index:`libgnunetdht <single: libgnunet; dht>`
-----------------------------------------------
+libgnunetdht
+------------
The DHT API itself is pretty simple and offers the usual GET and PUT
functions that work as expected. The specified block type refers to the
@@ -321,7 +322,7 @@ explicit \"stop\" message is more common as this allows a client to run
many concurrent GET operations over the same connection with the DHT
service --- and to stop them individually.
-.. _Monitoring-the-DHT:
+.. _Monitoring-DHT:
Monitoring the DHT
^^^^^^^^^^^^^^^^^^
diff --git a/developers/subsystems/fs/fs.rst b/developers/subsystems/fs/fs.rst
@@ -36,7 +36,8 @@ ECRS on-demand encoding is implemented in the FS service.
see: Encoding for Censorship-Resistant Sharing; ECRS
:index:`ECRS — Encoding for Censorship-Resistant Sharing <single: ECRS>`
-------------------------------------------------------------------------
+ECRS — Encoding for Censorship-Resistant Sharing
+------------------------------------------------
When GNUnet shares files, it uses a content encoding that is called
ECRS, the Encoding for Censorship-Resistant Sharing. Most of ECRS is
diff --git a/developers/subsystems/gns/gns.rst b/developers/subsystems/gns/gns.rst
@@ -48,7 +48,8 @@ to enable applications to define new GNS record types.
:index:`libgnunetgns <single: libgnunet; gns>`
-----------------------------------------------
+libgnunetgns
+------------
The GNS API itself is extremely simple. Clients first connect to the GNS
service using ``GNUNET_GNS_connect``. They can then perform lookups
diff --git a/developers/subsystems/hostlist/hostlist.rst b/developers/subsystems/hostlist/hostlist.rst
@@ -142,7 +142,8 @@ to the TRANSPORT server to validate the addresses.
.. _The-HOSTLIST-daemon:
:index:`The HOSTLIST daemon <double: daemon; HOSTLIST>`
--------------------------------------------------------
+The HOSTLIST daemon
+-------------------
The hostlist daemon is the main component of the HOSTLIST subsystem. It
is started by the ARM service and (if configured) starts the HOSTLIST
@@ -172,7 +173,8 @@ all subsystems and disconnecting from CORE.
.. _The-HOSTLIST-server:
:index:`The HOSTLIST server <single: HOSTLIST; server>`
--------------------------------------------------------
+The HOSTLIST server
+-------------------
The server provides a way for other peers to obtain HELLOs. Basically it
is a small web server other peers can connect to and download a list of
@@ -261,7 +263,8 @@ information about the quality of this URL is updated.
.. _Learning:
:index:`Learning <single: HOSTLIST; learning>`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Learning
+^^^^^^^^
The client also manages hostlist advertisements from other peers. The
HOSTLIST daemon forwards ``GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT``
diff --git a/developers/subsystems/identity/identity.rst b/developers/subsystems/identity/identity.rst
@@ -52,7 +52,8 @@ code does not have to contain a special case to distinguish between
anonymous and pseudonymous egos.
:index:`libgnunetidentity <single: libgnunet; identity>`
---------------------------------------------------------
+libgnunetidentity
+-----------------
.. _Connecting-to-the-service:
diff --git a/developers/subsystems/messenger/messenger.rst b/developers/subsystems/messenger/messenger.rst
@@ -79,7 +79,8 @@ Also MESSENGER provides multiple features with privacy in mind:
:index:`libgnunetmessenger <single: libgnunet; messenger>`
-----------------------------------------------------------
+libgnunetmessenger
+------------------
The MESSENGER API (defined in ``gnunet_messenger_service.h``) allows P2P
applications built using GNUnet to communicate with specified kinds of
diff --git a/developers/subsystems/namecache/namecache.rst b/developers/subsystems/namecache/namecache.rst
@@ -35,7 +35,8 @@ The NAMECACHE supports the use of different database backends via a
plugin API.
:index:`libgnunetnamecache <single: libgnunet; namecache>`
-----------------------------------------------------------
+libgnunetnamecache
+------------------
The NAMECACHE API consists of five simple functions. First, there is
``GNUNET_NAMECACHE_connect`` to connect to the NAMECACHE service. This
diff --git a/developers/subsystems/namestore/namestore.rst b/developers/subsystems/namestore/namestore.rst
@@ -36,7 +36,8 @@ NAMESTORE functionality can be accessed using the NAMESTORE C API, the NAMESTORE
REST API, or the NAMESTORE command line tool.
:index:`libgnunetnamestore <single: libgnunet; namestore>`
-----------------------------------------------------------
+libgnunetnamestore
+------------------
To interact with NAMESTORE clients first connect to the NAMESTORE
service using the ``GNUNET_NAMESTORE_connect`` passing a configuration
diff --git a/developers/subsystems/nse/nse.rst b/developers/subsystems/nse/nse.rst
@@ -40,7 +40,8 @@ NSE security
.. _Security:
:index:`Security <single: NSE; security>`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Security
+^^^^^^^^
The NSE subsystem is designed to be resilient against these attacks. It
uses `proofs of
@@ -55,7 +56,8 @@ particular, peers cannot trigger global network communication at will.
.. _Principle:
:index:`Principle <single: NSE; principle of operation>`
---------------------------------------------------------
+Principle
+---------
The algorithm calculates the estimate by finding the globally closest
peer ID to a random, time-based value.
@@ -155,7 +157,8 @@ actual network size is calculated in powers of two of the raw input,
thus one bit of uncertainty means a factor of two in the size estimate.
:index:`libgnunetnse <single: libgnunet; nse>`
-----------------------------------------------
+libgnunetnse
+------------
The NSE subsystem has the simplest API of all services, with only two
calls: ``GNUNET_NSE_connect`` and ``GNUNET_NSE_disconnect``.
diff --git a/developers/subsystems/peerinfo/peerinfo.rst b/developers/subsystems/peerinfo/peerinfo.rst
@@ -156,7 +156,8 @@ final message is ``struct GNUNET_MessageHeader`` with type
message, it can proceed with the next request if any is pending.
:index:`libgnunetpeerinfo <single: libgnunet; peerinfo>`
---------------------------------------------------------
+libgnunetpeerinfo
+-----------------
The PEERINFO API consists mainly of three different functionalities:
diff --git a/developers/subsystems/peerstore/peerstore.rst b/developers/subsystems/peerstore/peerstore.rst
@@ -64,7 +64,8 @@ PEERSTORE implements the following components:
only an \"sqlite\" plugin is implemented.
:index:`libgnunetpeerstore <single: libgnunet; peerstore>`
-----------------------------------------------------------
+libgnunetpeerstore
+------------------
libgnunetpeerstore is the library containing the PEERSTORE API.
Subsystems wishing to communicate with the PEERSTORE service use this
diff --git a/developers/subsystems/revocation/revocation.rst b/developers/subsystems/revocation/revocation.rst
@@ -59,7 +59,8 @@ possession of the respective user. This is another reason to create a
revocation message ahead of time and store it in a secure location.
:index:`libgnunetrevocation <single: libgnunet; revocation>`
-------------------------------------------------------------
+libgnunetrevocation
+-------------------
The REVOCATION API consists of two parts, to query and to issue
revocations.
diff --git a/developers/subsystems/set/set.rst b/developers/subsystems/set/set.rst
@@ -85,7 +85,8 @@ operation's result set is delivered to the client:
:index:`libgnunetset <single: libgnunet; set>`
-----------------------------------------------
+libgnunetset
+------------
.. _Sets:
diff --git a/developers/subsystems/seti/seti.rst b/developers/subsystems/seti/seti.rst
@@ -64,7 +64,8 @@ result set is delivered to the client:
:index:`libgnunetseti <single: libgnunet; seti>`
-------------------------------------------------
+libgnunetseti
+-------------
.. _Intersection-Set-API:
diff --git a/developers/subsystems/setu/setu.rst b/developers/subsystems/setu/setu.rst
@@ -68,7 +68,8 @@ operation's result set is delivered to the client:
:index:`libgnunetsetu <single: libgnunet; setu>`
-------------------------------------------------
+libgnunetsetu
+-------------
.. _Union-Set-API:
diff --git a/developers/subsystems/statistics/statistics.rst b/developers/subsystems/statistics/statistics.rst
@@ -49,7 +49,8 @@ service shutdown helps other services to store important data to
STATISTICS during shutdown.
:index:`libgnunetstatistics <single: libgnunet; statistics>`
-------------------------------------------------------------
+libgnunetstatistics
+-------------------
**libgnunetstatistics** is the library containing the API for the
STATISTICS subsystem. Any process requiring to use STATISTICS should use
