From: Nils Gillmann <ng0@n0.is>
Date: Wed, 9 May 2018 08:38:49 +0000 (+0000)
Subject: doc: developer
X-Git-Tag: v0.11.0pre66~63
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e5e809d2a541bb2d710d607740caa9afeaaca74d;p=oweals%2Fgnunet.git

doc: developer

Signed-off-by: Nils Gillmann <ng0@n0.is>
---

diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi
index e95355302..6a895ed11 100644
--- a/doc/documentation/chapters/developer.texi
+++ b/doc/documentation/chapters/developer.texi
@@ -8381,7 +8381,7 @@ The REST service will automatically load all REST plugins on startup.
 
 @strong{Configuration}
 
-The rest service can be configured in various ways.
+The REST service can be configured in various ways.
 The reference config file can be found in 
 @file{src/rest/rest.conf}:
 @example
@@ -8392,8 +8392,11 @@ REST_ALLOW_ORIGIN=*
 REST_ALLOW_CREDENTIALS=true
 @end example
 
-The port as well as Cross-origin resource sharing (CORS) headers that
-are supposed to be advertised by the rest service are configurable.
+The port as well as
+@deffn{cross-origin resource sharing} (CORS)
+@end deffn
+headers that are supposed to be advertised by the rest service are
+configurable.
 
 @menu
 * Namespace considerations::
@@ -8403,14 +8406,15 @@ are supposed to be advertised by the rest service are configurable.
 @node Namespace considerations
 @subsection Namespace considerations
 
-The gnunet-rest-service will load all plugins that are installed.
+The @command{gnunet-rest-service} will load all plugins that are installed.
 As such it is important that the endpoint namespaces do not clash.
-For example, plugin X might expose the endpoint ``/xxx'' while plugin Y exposes
-endpoint ``/xxx/yyy''.
-This is a problem if plugins X is also supposed to handle a call to 
-``/xxx/yyy''.
-Currently, the REST service will not complain or warn about such clashes so
-please make sure that endpoints are unambiguous.
+
+For example, plugin X might expose the endpoint ``/xxx'' while plugin Y
+exposes endpoint ``/xxx/yyy''.
+This is a problem if plugin X is also supposed to handle a call
+to ``/xxx/yyy''.
+Currently the REST service will not complain or warn about such clashes,
+so please make sure that endpoints are unambiguous.
 
 @node Endpoint documentation
 @subsection Endpoint documentation
@@ -8418,4 +8422,3 @@ please make sure that endpoints are unambiguous.
 This is WIP. Endpoints should be documented appropriately.
 Perferably using annotations.
 
-