diff options
-rw-r--r-- | contrib/packages/guix/gnunet-doc.scm | 165 | ||||
-rw-r--r-- | doc/Makefile.am | 61 | ||||
-rw-r--r-- | doc/figs/Service.pdf | bin | 7303 -> 0 bytes | |||
-rw-r--r-- | doc/figs/System.pdf | bin | 7897 -> 0 bytes | |||
-rw-r--r-- | doc/gnunet-c-tutorial.texi | 6 | ||||
-rw-r--r-- | doc/images/gnunet-tutorial-service.png | bin | 0 -> 40142 bytes | |||
-rw-r--r-- | doc/images/gnunet-tutorial-system.png | bin | 0 -> 46982 bytes |
7 files changed, 203 insertions, 29 deletions
diff --git a/contrib/packages/guix/gnunet-doc.scm b/contrib/packages/guix/gnunet-doc.scm new file mode 100644 index 000000000..a2a9a2393 --- /dev/null +++ b/contrib/packages/guix/gnunet-doc.scm | |||
@@ -0,0 +1,165 @@ | |||
1 | ;;; This file is part of GNUnet. | ||
2 | ;;; Copyright (C) 2016, 2017 GNUnet e.V. | ||
3 | ;;; | ||
4 | ;;; GNUnet is free software; you can redistribute it and/or modify | ||
5 | ;;; it under the terms of the GNU General Public License as published | ||
6 | ;;; by the Free Software Foundation; either version 3, or (at your | ||
7 | ;;; option) any later version. | ||
8 | ;;; | ||
9 | ;;; GNUnet is distributed in the hope that it will be useful, but | ||
10 | ;;; WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
12 | ;;; General Public License for more details. | ||
13 | ;;; | ||
14 | ;;; You should have received a copy of the GNU General Public License | ||
15 | ;;; along with GNUnet; see the file COPYING. If not, write to the | ||
16 | ;;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | ||
17 | ;;; Boston, MA 02110-1301, USA. | ||
18 | ;;; | ||
19 | |||
20 | (use-modules | ||
21 | (ice-9 popen) | ||
22 | (ice-9 match) | ||
23 | (ice-9 rdelim) | ||
24 | (guix packages) | ||
25 | (guix build-system gnu) | ||
26 | (guix gexp) | ||
27 | ((guix build utils) #:select (with-directory-excursion)) | ||
28 | (guix git-download) | ||
29 | (guix utils) ; current-source-directory | ||
30 | (gnu packages) | ||
31 | (gnu packages aidc) | ||
32 | (gnu packages autotools) | ||
33 | (gnu packages backup) | ||
34 | (gnu packages base) | ||
35 | (gnu packages compression) | ||
36 | (gnu packages curl) | ||
37 | (gnu packages databases) | ||
38 | (gnu packages file) | ||
39 | (gnu packages gettext) | ||
40 | (gnu packages glib) | ||
41 | (gnu packages gnome) | ||
42 | (gnu packages gnunet) | ||
43 | (gnu packages gnupg) | ||
44 | (gnu packages gnuzilla) | ||
45 | (gnu packages groff) | ||
46 | (gnu packages gstreamer) | ||
47 | (gnu packages gtk) | ||
48 | (gnu packages guile) | ||
49 | (gnu packages image) | ||
50 | (gnu packages image-viewers) | ||
51 | (gnu packages libidn) | ||
52 | (gnu packages libunistring) | ||
53 | (gnu packages linux) | ||
54 | (gnu packages maths) | ||
55 | (gnu packages multiprecision) | ||
56 | (gnu packages perl) | ||
57 | (gnu packages pkg-config) | ||
58 | (gnu packages pulseaudio) | ||
59 | (gnu packages python) | ||
60 | (gnu packages tex) | ||
61 | (gnu packages texinfo) | ||
62 | (gnu packages tex) | ||
63 | (gnu packages tls) | ||
64 | (gnu packages video) | ||
65 | (gnu packages web) | ||
66 | (gnu packages xiph) | ||
67 | ((guix licenses) #:prefix license:)) | ||
68 | |||
69 | (define %source-dir (string-append (current-source-directory) | ||
70 | "/../../../")) | ||
71 | |||
72 | (define gnunet-doc | ||
73 | (let* ((revision "1") | ||
74 | (select? (delay (or (git-predicate | ||
75 | (string-append (current-source-directory) | ||
76 | "/../../../")) | ||
77 | source-file?)))) | ||
78 | (package | ||
79 | (name "gnunet-doc") | ||
80 | (version (string-append "0.10.1-" revision "." "dev")) | ||
81 | (source | ||
82 | (local-file ;;"../../.." | ||
83 | ;;%source-dir | ||
84 | ;;(string-append (getcwd) "/../../../") | ||
85 | (string-append (getcwd)) ;drrty hack and this assumes one static position FIXME! | ||
86 | #:recursive? #t)) | ||
87 | ;;#:select? (git-predicate %source-dir))) | ||
88 | ;;#:select? (force select?))) | ||
89 | (build-system gnu-build-system) | ||
90 | (inputs | ||
91 | `(("glpk" ,glpk) | ||
92 | ("gnurl" ,gnurl) | ||
93 | ("gstreamer" ,gstreamer) | ||
94 | ("gst-plugins-base" ,gst-plugins-base) | ||
95 | ("gnutls" ,gnutls) ;Change to gnutls/dane once it is merged. | ||
96 | ("libextractor" ,libextractor) | ||
97 | ("libgcrypt" ,libgcrypt) | ||
98 | ("libidn" ,libidn) | ||
99 | ("libmicrohttpd" ,libmicrohttpd) | ||
100 | ("libltdl" ,libltdl) | ||
101 | ("libunistring" ,libunistring) | ||
102 | ("openssl" ,openssl) | ||
103 | ("opus" ,opus) | ||
104 | ("pulseaudio" ,pulseaudio) | ||
105 | ("sqlite" ,sqlite) | ||
106 | ("postgresql" ,postgresql) | ||
107 | ("mysql" ,mysql) | ||
108 | ("zlib" ,zlib) | ||
109 | ("perl" ,perl) | ||
110 | ("python" ,python) ; tests and gnunet-qr | ||
111 | ("jansson" ,jansson) | ||
112 | ("nss" ,nss) | ||
113 | ("glib" ,glib "bin") | ||
114 | ("gmp" ,gmp) | ||
115 | ("bluez" ,bluez) ; for optional bluetooth feature | ||
116 | ("glib" ,glib) | ||
117 | ;;("texlive-minimal" ,texlive-minimal) ; optional. | ||
118 | ("texlive" ,texlive) | ||
119 | ("libogg" ,libogg))) | ||
120 | (native-inputs | ||
121 | `(("pkg-config" ,pkg-config) | ||
122 | ("autoconf" ,autoconf) | ||
123 | ("automake" ,automake) | ||
124 | ("gnu-gettext" ,gnu-gettext) | ||
125 | ("texinfo" ,texinfo) | ||
126 | ("libtool" ,libtool))) | ||
127 | (arguments | ||
128 | `(#:tests? #f ;Don't run tests | ||
129 | #:phases | ||
130 | (modify-phases %standard-phases | ||
131 | (add-after 'unpack 'autoconf | ||
132 | (lambda _ | ||
133 | (substitute* "bootstrap" | ||
134 | (("contrib/pogen.sh") "sh contrib/pogen.sh")) | ||
135 | (for-each (lambda (f) (chmod f #o755)) | ||
136 | (find-files "po" "")) | ||
137 | (zero? (system* "sh" "bootstrap")))) | ||
138 | (replace 'build | ||
139 | (lambda _ | ||
140 | (chdir "doc") | ||
141 | (zero? (system* "make" "doc-all-give-me-the-noise")))) | ||
142 | (replace 'install | ||
143 | (lambda* (#:key outputs #:allow-other-keys) | ||
144 | (let* ((out (assoc-ref outputs "out")) | ||
145 | (doc (string-append out "/share/doc/gnunet"))) | ||
146 | (mkdir-p doc) | ||
147 | (mkdir-p (string-append doc "/gnunet")) | ||
148 | (install-file "gnunet.pdf" doc) | ||
149 | (install-file "gnunet.info" doc) | ||
150 | (copy-recursively "gnunet" | ||
151 | (string-append doc | ||
152 | "/gnunet")) | ||
153 | (install-file "gnunet-c-tutorial.pdf" doc) | ||
154 | (install-file "gnunet-c-tutorial.info" doc) | ||
155 | (copy-recursively "gnunet-c-tutorial" | ||
156 | (string-append doc | ||
157 | "/gnunet-c-tutorial"))) | ||
158 | #t))))) | ||
159 | (synopsis "Documentation of GNUnet") | ||
160 | (description | ||
161 | "GNUnet documentation build") | ||
162 | (license (list license:fdl1.3+ license:gpl3+)) | ||
163 | (home-page "https://gnunet.org/")))) | ||
164 | |||
165 | gnunet-doc | ||
diff --git a/doc/Makefile.am b/doc/Makefile.am index c97e0f6d9..8463c7129 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am | |||
@@ -3,34 +3,38 @@ SUBDIRS = man doxygen | |||
3 | 3 | ||
4 | docdir = $(datadir)/doc/gnunet/ | 4 | docdir = $(datadir)/doc/gnunet/ |
5 | 5 | ||
6 | gnunet_doc_images = \ | 6 | infoimagedir = $(infodir)/images |
7 | images/gnunet-gtk-0-10-gns-a-done.png \ | 7 | |
8 | images/gnunet-gtk-0-10-gns-a.png \ | 8 | dist_infoimage_DATA = \ |
9 | images/daemon_lego_block.png \ | 9 | %D%/images/gnunet-gtk-0-10-gns-a-done.png \ |
10 | images/gnunet-gtk-0-10-gns.png \ | 10 | %D%/images/gnunet-gtk-0-10-gns-a.png \ |
11 | images/gnunet-0-10-peerinfo.png \ | 11 | %D%/images/daemon_lego_block.png \ |
12 | images/gnunet-gtk-0-10-identity.png \ | 12 | %D%/images/gnunet-gtk-0-10-gns.png \ |
13 | images/gnunet-fs-gtk-0-10-star-tab.png \ | 13 | %D%/images/gnunet-0-10-peerinfo.png \ |
14 | images/gnunet-gtk-0-10.png \ | 14 | %D%/images/gnunet-gtk-0-10-identity.png \ |
15 | images/gnunet-gtk-0-10-download-area.png \ | 15 | %D%/images/gnunet-fs-gtk-0-10-star-tab.png \ |
16 | images/gnunet-gtk-0-10-search-selected.png \ | 16 | %D%/images/gnunet-gtk-0-10.png \ |
17 | images/gnunet-gtk-0-10-fs-menu.png \ | 17 | %D%/images/gnunet-gtk-0-10-download-area.png \ |
18 | images/gnunet-gtk-0-10-traffic.png \ | 18 | %D%/images/gnunet-gtk-0-10-search-selected.png \ |
19 | images/gnunet-gtk-0-10-fs.png \ | 19 | %D%/images/gnunet-gtk-0-10-fs-menu.png \ |
20 | images/gnunet-namestore-gtk-phone.png \ | 20 | %D%/images/gnunet-gtk-0-10-traffic.png \ |
21 | images/gnunet-gtk-0-10-fs-publish-editing.png \ | 21 | %D%/images/gnunet-gtk-0-10-fs.png \ |
22 | images/gnunet-namestore-gtk-vpn.png \ | 22 | %D%/images/gnunet-namestore-gtk-phone.png \ |
23 | images/gnunet-gtk-0-10-fs-published.png \ | 23 | %D%/images/gnunet-gtk-0-10-fs-publish-editing.png \ |
24 | images/gnunet-setup-exit.png \ | 24 | %D%/images/gnunet-namestore-gtk-vpn.png \ |
25 | images/gnunet-gtk-0-10-fs-publish.png \ | 25 | %D%/images/gnunet-gtk-0-10-fs-published.png \ |
26 | images/iceweasel-preferences.png \ | 26 | %D%/images/gnunet-setup-exit.png \ |
27 | images/gnunet-gtk-0-10-fs-publish-select.png \ | 27 | %D%/images/gnunet-gtk-0-10-fs-publish.png \ |
28 | images/iceweasel-proxy.png \ | 28 | %D%/images/iceweasel-preferences.png \ |
29 | images/gnunet-gtk-0-10-fs-publish-with-file_0.png \ | 29 | %D%/images/gnunet-gtk-0-10-fs-publish-select.png \ |
30 | images/service_lego_block.png \ | 30 | %D%/images/iceweasel-proxy.png \ |
31 | images/gnunet-gtk-0-10-fs-publish-with-file.png \ | 31 | %D%/images/gnunet-gtk-0-10-fs-publish-with-file_0.png \ |
32 | images/service_stack.png \ | 32 | %D%/images/service_lego_block.png \ |
33 | images/gnunet-gtk-0-10-fs-search.png | 33 | %D%/images/gnunet-gtk-0-10-fs-publish-with-file.png \ |
34 | %D%/images/service_stack.png \ | ||
35 | %D%/images/gnunet-gtk-0-10-fs-search.png \ | ||
36 | %D%/images/gnunet-tutorial-service.png \ | ||
37 | %D%/images/gnunet-tutorial-system.png | ||
34 | 38 | ||
35 | gnunet_tutorial_examples = \ | 39 | gnunet_tutorial_examples = \ |
36 | 001.c \ | 40 | 001.c \ |
@@ -74,7 +78,6 @@ gnunet_TEXINFOS = \ | |||
74 | 78 | ||
75 | EXTRA_DIST = \ | 79 | EXTRA_DIST = \ |
76 | $(gnunet_TEXINFOS) \ | 80 | $(gnunet_TEXINFOS) \ |
77 | $(gnunet_doc_images) \ | ||
78 | $(gnunet_tutorial_examples) \ | 81 | $(gnunet_tutorial_examples) \ |
79 | outdated-and-old-installation-instructions.txt \ | 82 | outdated-and-old-installation-instructions.txt \ |
80 | gnunet-c-tutorial-v1.pdf \ | 83 | gnunet-c-tutorial-v1.pdf \ |
diff --git a/doc/figs/Service.pdf b/doc/figs/Service.pdf deleted file mode 100644 index e9569cc7a..000000000 --- a/doc/figs/Service.pdf +++ /dev/null | |||
Binary files differ | |||
diff --git a/doc/figs/System.pdf b/doc/figs/System.pdf deleted file mode 100644 index 70dc6ff2b..000000000 --- a/doc/figs/System.pdf +++ /dev/null | |||
Binary files differ | |||
diff --git a/doc/gnunet-c-tutorial.texi b/doc/gnunet-c-tutorial.texi index 2e4bd9a45..4f56ae5c4 100644 --- a/doc/gnunet-c-tutorial.texi +++ b/doc/gnunet-c-tutorial.texi | |||
@@ -228,6 +228,12 @@ a DHT). | |||
228 | @c** FXIME: See comment above. | 228 | @c** FXIME: See comment above. |
229 | @c** See figure ~\ref{fig:interaction} for an illustration of this approach. | 229 | @c** See figure ~\ref{fig:interaction} for an illustration of this approach. |
230 | 230 | ||
231 | @c ** @image{filename[, width[, height[, alttext[, extension]]]]} | ||
232 | |||
233 | @image{images/gnunet-tutorial-service,,5in,Service with API and network protocol,.png} | ||
234 | |||
235 | @image{images/gnunet-tutorial-system,,5in,The layered system architecture of GNUnet,.png} | ||
236 | |||
231 | @c \begin{figure}[!h] | 237 | @c \begin{figure}[!h] |
232 | @c \begin{center} | 238 | @c \begin{center} |
233 | @c % \begin{subfigure} | 239 | @c % \begin{subfigure} |
diff --git a/doc/images/gnunet-tutorial-service.png b/doc/images/gnunet-tutorial-service.png new file mode 100644 index 000000000..6daed2f35 --- /dev/null +++ b/doc/images/gnunet-tutorial-service.png | |||
Binary files differ | |||
diff --git a/doc/images/gnunet-tutorial-system.png b/doc/images/gnunet-tutorial-system.png new file mode 100644 index 000000000..8b54e16cf --- /dev/null +++ b/doc/images/gnunet-tutorial-system.png | |||
Binary files differ | |||