diff options
author | Martin Schanzenbach <mschanzenbach@posteo.de> | 2020-07-06 10:27:02 +0200 |
---|---|---|
committer | Martin Schanzenbach <mschanzenbach@posteo.de> | 2020-07-06 10:27:02 +0200 |
commit | 80ee82d9f984ffe30fa77f30d153e60a383709a6 (patch) | |
tree | 3a58a37cee236da31dea697e7cf0c0dffc42b912 /doc/handbook/chapters | |
parent | 23fc3bf6abf1557a6f114af2016abafd5de6a0fe (diff) | |
download | gnunet-80ee82d9f984ffe30fa77f30d153e60a383709a6.tar.gz gnunet-80ee82d9f984ffe30fa77f30d153e60a383709a6.zip |
-fix: handbook updates
Diffstat (limited to 'doc/handbook/chapters')
-rw-r--r-- | doc/handbook/chapters/developer.texi | 37 | ||||
-rw-r--r-- | doc/handbook/chapters/preface.texi | 11 |
2 files changed, 27 insertions, 21 deletions
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi index ca76a5f2b..fd48fb9ab 100644 --- a/doc/handbook/chapters/developer.texi +++ b/doc/handbook/chapters/developer.texi | |||
@@ -92,33 +92,25 @@ introduction, each of the GNUnet subsystems (directories in the | |||
92 | addition to this documentation, GNUnet developers should be aware of the | 92 | addition to this documentation, GNUnet developers should be aware of the |
93 | services available on the GNUnet server to them. | 93 | services available on the GNUnet server to them. |
94 | 94 | ||
95 | New developers can have a look a the GNUnet tutorials for C and java | 95 | New developers can have a look a the @uref{https://docs.gnunet.org/tutorial/gnunet-tutorial.html, GNUnet C tutorial}. |
96 | available in the @file{src/} directory of the repository or under the | ||
97 | following links: | ||
98 | 96 | ||
99 | @c ** FIXME: Link to files in source, not online. | 97 | @c ** FIXME: Link to files in source, not online. |
100 | @c ** FIXME: Where is the Java tutorial? | 98 | @c ** FIXME: Where is the Java tutorial? |
101 | @itemize @bullet | ||
102 | @item @xref{Top, Introduction,, gnunet-c-tutorial, The GNUnet C Tutorial}. | ||
103 | @item @uref{https://docs.gnunet.org/tutorial/gnunet-tutorial.html, GNUnet C tutorial} | ||
104 | @item GNUnet Java tutorial | ||
105 | @end itemize | ||
106 | 99 | ||
107 | In addition to the GNUnet Reference Documentation you are reading, | 100 | In addition to the GNUnet Reference Documentation you are reading, |
108 | the GNUnet server at @uref{https://gnunet.org} contains | 101 | the GNUnet server at @uref{https://gnunet.org} contains |
109 | various resources for GNUnet developers and those | 102 | various resources for GNUnet developers and those |
110 | who aspire to become regular contributors. | 103 | who aspire to become regular contributors. |
111 | They are all conveniently reachable via the "Developer" | 104 | They are all conveniently reachable via the "Developer" |
112 | entry in the navigation menu. Some additional tools (such as static | 105 | entry in the navigation menu. Some additional tools (such as continuous |
113 | analysis reports) require a special developer access to perform certain | 106 | integration) require a special developer access to perform certain |
114 | operations. If you want (or require) access, you should contact | 107 | operations. If you want (or require) access, you should contact |
115 | @uref{http://grothoff.org/christian/, Christian Grothoff}, | 108 | GNUnet's maintainers. |
116 | GNUnet's maintainer. | ||
117 | 109 | ||
118 | @c FIXME: A good part of this belongs on the website or should be | 110 | @c FIXME: A good part of this belongs on the website or should be |
119 | @c extended in subsections explaining usage of this. A simple list | 111 | @c extended in subsections explaining usage of this. A simple list |
120 | @c is just taking space people have to read. | 112 | @c is just taking space people have to read. |
121 | The public subsystems on the GNUnet server that help developers are: | 113 | The developer services on the GNUnet project infrastructure are: |
122 | 114 | ||
123 | @itemize @bullet | 115 | @itemize @bullet |
124 | 116 | ||
@@ -136,19 +128,21 @@ It can be accessed at | |||
136 | @uref{https://bugs.gnunet.org/, https://bugs.gnunet.org/}. | 128 | @uref{https://bugs.gnunet.org/, https://bugs.gnunet.org/}. |
137 | Anyone can report bugs. | 129 | Anyone can report bugs. |
138 | 130 | ||
139 | @item The current quality of our automated test suite is assessed using | 131 | @item Continuous integration (Buildbot). |
140 | code coverage analysis. Testcases that | 132 | Used to build gnunet and its websites upon new commits. |
141 | improve our code coverage are always welcome. | 133 | It can be accessed at |
134 | @uref{https://buildbot.gnunet.org/, https://buildbot.gnunet.org/}. | ||
135 | Anyone can see the builds. | ||
142 | 136 | ||
143 | @item We try to automatically find bugs using a static analysis using | 137 | @item Regularly we make use of static analysis tools. |
144 | various tools. Note that not everything that is flagged by the | 138 | Note that not everything that is flagged by the |
145 | analysis is a bug, sometimes even good code can be marked as possibly | 139 | analysis is a bug, sometimes even good code can be marked as possibly |
146 | problematic. Nevertheless, developers are encouraged to at least be | 140 | problematic. Nevertheless, developers are encouraged to at least be |
147 | aware of all issues in their code that are listed. | 141 | aware of all issues in their code that are listed. |
148 | 142 | ||
149 | @item We use Gauger for automatic performance regression visualization. | 143 | @c @item We use Gauger for automatic performance regression visualization. |
150 | @c FIXME: LINK! | 144 | @c FIXME: LINK! |
151 | Details on how to use Gauger are here. | 145 | @c Details on how to use Gauger are here. |
152 | 146 | ||
153 | @end itemize | 147 | @end itemize |
154 | 148 | ||
@@ -515,6 +509,9 @@ without exposing the private input vectors of the peers to each other. | |||
515 | @item @file{consensus/} | 509 | @item @file{consensus/} |
516 | The consensus service will allow a set of peers to agree | 510 | The consensus service will allow a set of peers to agree |
517 | on a set of values via a distributed set union computation. | 511 | on a set of values via a distributed set union computation. |
512 | @item @file{reclaim/} | ||
513 | A decentralized personal data sharing service used to realize a decentralized | ||
514 | identity provider. Supports OpenID Connect. See also @uref{https://reclaim.gnunet.org}. | ||
518 | @item @file{rest/} | 515 | @item @file{rest/} |
519 | The rest API allows access to GNUnet services using RESTful interaction. | 516 | The rest API allows access to GNUnet services using RESTful interaction. |
520 | The services provide plugins that can exposed by the rest server. | 517 | The services provide plugins that can exposed by the rest server. |
diff --git a/doc/handbook/chapters/preface.texi b/doc/handbook/chapters/preface.texi index 443fb2600..e64d6ee55 100644 --- a/doc/handbook/chapters/preface.texi +++ b/doc/handbook/chapters/preface.texi | |||
@@ -1,4 +1,4 @@ | |||
1 | @node Preface | 1 | doc/handbook/chapters/preface.texi@node Preface |
2 | @chapter Preface | 2 | @chapter Preface |
3 | 3 | ||
4 | @c FIXME: Do we have to mention that this is Free Software? | 4 | @c FIXME: Do we have to mention that this is Free Software? |
@@ -181,6 +181,15 @@ GNUnet maintainer can overrule any decisions made by individual | |||
181 | developers. Still, in practice neither has happened in the last 20 | 181 | developers. Still, in practice neither has happened in the last 20 |
182 | years for GNUnet, and we hope to keep it that way. | 182 | years for GNUnet, and we hope to keep it that way. |
183 | 183 | ||
184 | The current maintainers of GNUnet are: | ||
185 | |||
186 | @itemize @bullet | ||
187 | |||
188 | @item @uref{Christian Grothoff, https://grothoff.org/christian/} | ||
189 | @item @uref{Martin Schanzenbach, https://schanzen.eu} | ||
190 | |||
191 | @end itemize | ||
192 | |||
184 | The GNUnet project is supported by GNUnet e.V., a German association | 193 | The GNUnet project is supported by GNUnet e.V., a German association |
185 | where any developer can become a member. GNUnet e.V. serves as a | 194 | where any developer can become a member. GNUnet e.V. serves as a |
186 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also | 195 | legal entity to hold the copyrights to GNUnet. GNUnet e.V. may also |