aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2018-02-04 15:28:39 +0000
committerng0 <ng0@n0.is>2018-02-04 15:28:39 +0000
commit5c277f0ddb5d8335424157b861ab1003d4a66a63 (patch)
tree4316b8a047b7314a41e6c1b2b1fb6f7cf77b1eaa /doc/documentation
parentf0421e81236f46087e693aa9e5a8c7a64174574d (diff)
downloadgnunet-5c277f0ddb5d8335424157b861ab1003d4a66a63.tar.gz
gnunet-5c277f0ddb5d8335424157b861ab1003d4a66a63.zip
couple of doc developer changes and notes
Diffstat (limited to 'doc/documentation')
-rw-r--r--doc/documentation/chapters/developer.texi32
1 files changed, 21 insertions, 11 deletions
diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi
index 21c158998..0b8c7e488 100644
--- a/doc/documentation/chapters/developer.texi
+++ b/doc/documentation/chapters/developer.texi
@@ -11,7 +11,7 @@ For developers, GNUnet is:
11@itemize @bullet 11@itemize @bullet
12@item developed by a community that believes in the GNU philosophy 12@item developed by a community that believes in the GNU philosophy
13@item Free Software (Free as in Freedom), licensed under the 13@item Free Software (Free as in Freedom), licensed under the
14GNU General Public License 14GNU General Public License@footnote{@uref{https://www.gnu.org/licenses/licenses.html#GPL, https://www.gnu.org/licenses/licenses.html#GPL}}
15@item A set of standards, including coding conventions and 15@item A set of standards, including coding conventions and
16architectural rules 16architectural rules
17@item A set of layered protocols, both specifying the communication 17@item A set of layered protocols, both specifying the communication
@@ -24,7 +24,7 @@ writing extensions
24In particular, the architecture specifies that a peer consists of many 24In particular, the architecture specifies that a peer consists of many
25processes communicating via protocols. Processes can be written in almost 25processes communicating via protocols. Processes can be written in almost
26any language. 26any language.
27C and Java @footnote{As well as Guile} APIs exist for accessing existing 27@code{C}, @code{Java} and @code{Guile} APIs exist for accessing existing
28services and for writing extensions. 28services and for writing extensions.
29It is possible to write extensions in other languages by 29It is possible to write extensions in other languages by
30implementing the necessary IPC protocols. 30implementing the necessary IPC protocols.
@@ -111,6 +111,9 @@ operations. If you want (or require) access, you should contact
111@uref{http://grothoff.org/christian/, Christian Grothoff}, 111@uref{http://grothoff.org/christian/, Christian Grothoff},
112GNUnet's maintainer. 112GNUnet's maintainer.
113 113
114@c FIXME: A good part of this belongs on the website or should be
115@c extended in subsections explaining usage of this. A simple list
116@c is just taking space people have to read.
114The public subsystems on the GNUnet server that help developers are: 117The public subsystems on the GNUnet server that help developers are:
115 118
116@itemize @bullet 119@itemize @bullet
@@ -119,20 +122,21 @@ The public subsystems on the GNUnet server that help developers are:
119distributed development. 122distributed development.
120It is publicly accessible at @uref{https://gnunet.org/git/}. 123It is publicly accessible at @uref{https://gnunet.org/git/}.
121Only developers with write access can commit code, everyone else is 124Only developers with write access can commit code, everyone else is
122encouraged to submit patches to the 125encouraged to submit patches to the GNUnet-developers mailinglist:
123@uref{https://lists.gnu.org/mailman/listinfo/gnunet-developers, GNUnet-developers mailinglist}. 126@uref{https://lists.gnu.org/mailman/listinfo/gnunet-developers, https://lists.gnu.org/mailman/listinfo/gnunet-developers}
124 127
125@item The bugtracking system (Mantis). 128@item The bugtracking system (Mantis).
126We use it to track feature requests, open bug reports and their 129We use it to track feature requests, open bug reports and their
127resolutions. 130resolutions.
128It can be accessed at @uref{https://gnunet.org/bugs/}. 131It can be accessed at
129Anyone can report bugs, but only developers can claim to have fixed them. 132@uref{https://gnunet.org/bugs/, https://gnunet.org/bugs/}.
133Anyone can report bugs.
130 134
131@item Our site installation of the 135@item Our site installation of the
132CI@footnote{Continuous Integration} system @code{Buildbot} is used 136CI@footnote{Continuous Integration} system @code{Buildbot} is used
133to check GNUnet builds automatically on a range of platforms. 137to check GNUnet builds automatically on a range of platforms.
134The web interface of this CI is exposed at 138The web interface of this CI is exposed at
135@uref{https://gnunet.org/buildbot/}. 139@uref{https://gnunet.org/buildbot/, https://gnunet.org/buildbot/}.
136Builds are triggered automatically 30 minutes after the last commit to 140Builds are triggered automatically 30 minutes after the last commit to
137our repository was made. 141our repository was made.
138 142
@@ -149,12 +153,13 @@ as possibly problematic. Nevertheless, developers are encouraged to at
149least be aware of all issues in their code that are listed. 153least be aware of all issues in their code that are listed.
150 154
151@item We use Gauger for automatic performance regression visualization. 155@item We use Gauger for automatic performance regression visualization.
156@c FIXME: LINK!
152Details on how to use Gauger are here. 157Details on how to use Gauger are here.
153 158
154@item We use @uref{http://junit.org/, junit} to automatically test 159@item We use @uref{http://junit.org/, junit} to automatically test
155@command{gnunet-java}. 160@command{gnunet-java}.
156Automatically generated, current reports on the test suite are here. 161Automatically generated, current reports on the test suite are here.
157@c FIXME: URL. 162@c FIXME: Likewise.
158 163
159@item We use Cobertura to generate test coverage reports for gnunet-java. 164@item We use Cobertura to generate test coverage reports for gnunet-java.
160Current reports on test coverage are here. 165Current reports on test coverage are here.
@@ -450,15 +455,20 @@ on a set of values via a distributed set union computation.
450@item @file{rest/} 455@item @file{rest/}
451The rest API allows access to GNUnet services using RESTful interaction. 456The rest API allows access to GNUnet services using RESTful interaction.
452The services provide plugins that can exposed by the rest server. 457The services provide plugins that can exposed by the rest server.
453@item @file{experimentation/} 458@c FIXME: Where did this disappear to?
454The experimentation daemon coordinates distributed 459@c @item @file{experimentation/}
455experimentation to evaluate transport and ATS properties. 460@c The experimentation daemon coordinates distributed
461@c experimentation to evaluate transport and ATS properties.
456@end table 462@end table
457 463
458@c *********************************************************************** 464@c ***********************************************************************
459@node System Architecture 465@node System Architecture
460@section System Architecture 466@section System Architecture
461 467
468@c FIXME: For those irritated by the textflow, we are missing images here,
469@c in the short term we should add them back, in the long term this should
470@c work without images or have images with alt-text.
471
462GNUnet developers like LEGOs. The blocks are indestructible, can be 472GNUnet developers like LEGOs. The blocks are indestructible, can be
463stacked together to construct complex buildings and it is generally easy 473stacked together to construct complex buildings and it is generally easy
464to swap one block for a different one that has the same shape. GNUnet's 474to swap one block for a different one that has the same shape. GNUnet's