summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlessio Vanni <vannilla@firemail.cc>2021-09-07 14:50:20 +0200
committerAlessio Vanni <vannilla@firemail.cc>2021-09-07 14:50:20 +0200
commit6e1bb6601e21a3329950129b9dc39e05746e3b65 (patch)
treedfc20058c8b430ef37c059ec21c2905168a07084 /doc
parent382fc8faaf4ccccd870dc7e746a9f002f3f6cfd1 (diff)
parent3da9cbd621a98c885a0c633ddaec0a84aa8a8e66 (diff)
-Merge branch 'master' into dev/vanni/build-info
Diffstat (limited to 'doc')
-rw-r--r--doc/handbook/Makefile.am106
-rw-r--r--doc/handbook/chapters/developer.texi28
-rw-r--r--doc/man/gnunet-search.12
3 files changed, 81 insertions, 55 deletions
diff --git a/doc/handbook/Makefile.am b/doc/handbook/Makefile.am
index d7bcab696..7c10b417a 100644
--- a/doc/handbook/Makefile.am
+++ b/doc/handbook/Makefile.am
@@ -1,48 +1,8 @@
# This Makefile.am is in the public domain
docdir = $(datadir)/doc/gnunet/
-infoimagedir = $(infodir)/images
-
AM_MAKEINFOHTMLFLAGS = $(TEXINFO_HTMLFLAGS)
-
-dist_infoimage_DATA = \
- images/gnunet-gtk-0-10-gns-a-done.png \
- images/gnunet-gtk-0-10-gns-a.png \
- images/daemon_lego_block.png \
- images/gnunet-gtk-0-10-gns.png \
- images/gnunet-0-10-peerinfo.png \
- images/gnunet-gtk-0-10-identity.png \
- images/gnunet-fs-gtk-0-10-star-tab.png \
- images/gnunet-gtk-0-10-download-area.png \
- images/gnunet-gtk-0-10-search-selected.png \
- images/gnunet-gtk-0-10-fs-menu.png \
- images/gnunet-gtk-0-10-traffic.png \
- images/gnunet-gtk-0-10-fs.png \
- images/gnunet-namestore-gtk-phone.png \
- images/gnunet-gtk-0-10-fs-publish-editing.png \
- images/gnunet-namestore-gtk-vpn.png \
- images/gnunet-gtk-0-10-fs-published.png \
- images/gnunet-setup-exit.png \
- images/gnunet-gtk-0-10-fs-publish.png \
- images/iceweasel-preferences.png \
- images/gnunet-gtk-0-10-fs-publish-select.png \
- images/iceweasel-proxy.png \
- images/gnunet-gtk-0-10-fs-publish-with-file_0.png \
- images/service_lego_block.png \
- images/gnunet-gtk-0-10-fs-publish-with-file.png \
- images/service_stack.png \
- images/gnunet-gtk-0-10-fs-search.png \
- images/gnunet-tutorial-service.png \
- images/gnunet-tutorial-system.png \
- images/daemon_lego_block.svg \
- images/lego_stack.svg \
- images/service_lego_block.svg \
- images/structure.dot \
- images/gns.dot \
- images/gns.jpg
-
-
info_TEXINFOS = \
gnunet.texi
@@ -83,24 +43,64 @@ gnunet_TEXINFOS = \
EXTRA_DIST = \
$(gnunet_TEXINFOS) \
htmlxref.cnf \
- version.texi \
+ version.texi \
run-gendocs.sh \
- docstyle.css \
- manual.css \
- reset.css \
- style.css
+ docstyle.css \
+ manual.css \
+ reset.css \
+ style.css \
+ images/daemon_lego_block.svg \
+ images/lego_stack.svg \
+ images/service_lego_block.svg \
+ images/gns.dot \
+ images/structure.dot \
+ images/tng.dot \
+ images/ascension_interaction.png \
+ images/ascension_ssd.png \
+ images/messenger_room.png \
+ images/gnunet-gtk-0-10-gns-a-done.png \
+ images/gnunet-gtk-0-10-gns-a.png \
+ images/daemon_lego_block.png \
+ images/gnunet-gtk-0-10-gns.png \
+ images/gnunet-0-10-peerinfo.png \
+ images/gnunet-gtk-0-10-identity.png \
+ images/gnunet-fs-gtk-0-10-star-tab.png \
+ images/gnunet-gtk-0-10-download-area.png \
+ images/gnunet-gtk-0-10-search-selected.png \
+ images/gnunet-gtk-0-10-fs-menu.png \
+ images/gnunet-gtk-0-10-traffic.png \
+ images/gnunet-gtk-0-10-fs.png \
+ images/gnunet-namestore-gtk-phone.png \
+ images/gnunet-gtk-0-10-fs-publish-editing.png \
+ images/gnunet-namestore-gtk-vpn.png \
+ images/gnunet-gtk-0-10-fs-published.png \
+ images/gnunet-setup-exit.png \
+ images/gnunet-gtk-0-10-fs-publish.png \
+ images/iceweasel-preferences.png \
+ images/gnunet-gtk-0-10-fs-publish-select.png \
+ images/iceweasel-proxy.png \
+ images/gnunet-gtk-0-10-fs-publish-with-file_0.png \
+ images/service_lego_block.png \
+ images/gnunet-gtk-0-10-fs-publish-with-file.png \
+ images/service_stack.png \
+ images/gnunet-gtk-0-10-fs-search.png \
+ images/gnunet-tutorial-service.png \
+ images/gnunet-tutorial-system.png \
+ images/gns.jpg \
+ images/tng.png
+
DISTCLEANFILES = \
- gnunet.cps \
- chapters/developer.cps \
- chapters/installation.cps \
- chapter/philosophy.cps \
+ gnunet.cps \
+ chapters/developer.cps \
+ chapters/installation.cps \
+ chapter/philosophy.cps \
chapters/user.cps \
- chapters/configuration.cps \
- chapters/terminology.cps \
- chapters/vocabulary.cps \
- fdl-1.3.cps \
+ chapters/configuration.cps \
+ chapters/terminology.cps \
+ chapters/vocabulary.cps \
+ fdl-1.3.cps \
agpl-3.0.cps \
gpl-3.0.cps
diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi
index 3d9493cec..cf13fd816 100644
--- a/doc/handbook/chapters/developer.texi
+++ b/doc/handbook/chapters/developer.texi
@@ -689,6 +689,7 @@ Here you can find some rules to help you write code for GNUnet.
@menu
* Naming conventions::
* Coding style::
+* Continuous integration::
* Commit messages and developer branches::
@end menu
@@ -1094,6 +1095,33 @@ fun (short i,
@end itemize
+@cindex Continuous integration
+@node Continuous integration
+@subsection Continuous integration
+
+The continuous integration buildbot can be found at @uref{https://buildbot.gnunet.org}.
+Repositories need to be enabled by a buildbot admin in order to participate
+in the builds.
+
+The buildbot can be configured to process scripts in your repository root under @code{.buildbot/}:
+
+The files @code{build.sh}, @code{install.sh} and @code{test.sh} are executed
+in order if present. If you want a specific worker to behave differently,
+you can provide a worker specific script, e.g. @code{myworker_build.sh}.
+In this case, the generic step will not be executed.
+
+For the @code{gnunet.git} repository, you may use "!tarball" or "!coverity" in
+your commit messages.
+"!tarball" will trigger a @code{make dist} of the gnunet source and verify that it
+can be compiled. The artifact will then be published to @uref{https://buildbot.gnunet.org/artifacts}.
+This is a good way to create a tarball for a release as it verifies the build
+on another machine.
+
+The "!coverity" trigger will trigger a coverity build and submit the results
+for analysis to coverity: @uref{https://scan.coverity.com/}.
+Only developers with accounts for the GNUnet project on coverity.com are able to
+see the analysis results.
+
@cindex Commit messages and developer branches
@node Commit messages and developer branches
@subsection Commit messages and developer branches
diff --git a/doc/man/gnunet-search.1 b/doc/man/gnunet-search.1
index a1c88f869..4ec5189de 100644
--- a/doc/man/gnunet-search.1
+++ b/doc/man/gnunet-search.1
@@ -126,9 +126,7 @@ Search results are printed by gnunet-search like this:
.Pp
.ad l
gnunet-download -o "COPYING" gnunet://fs/chk/HASH1.HASH2.SIZE
-
Description: The GNU General Public License
-
Mime-type: text/plain
.ad b