From 6667b33fde4d819385f9363601db58378560af28 Mon Sep 17 00:00:00 2001 From: ng0 Date: Thu, 26 Oct 2017 12:49:54 +0000 Subject: [PATCH] "@code{}" -> @code{} --- doc/documentation/chapters/developer.texi | 12 ++++++------ doc/documentation/chapters/installation.texi | 20 ++++++++++---------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi index 9459068a9..f98b62e10 100644 --- a/doc/documentation/chapters/developer.texi +++ b/doc/documentation/chapters/developer.texi @@ -125,7 +125,7 @@ It can be accessed at @uref{https://gnunet.org/bugs/}. Anyone can report bugs, but only developers can claim to have fixed them. @item Our site installation of the -CI@footnote{Continuous Integration} system "@code{Buildbot}" is used +CI@footnote{Continuous Integration} system @code{Buildbot} is used to check GNUnet builds automatically on a range of platforms. The web interface of this CI is exposed at @uref{https://gnunet.org/buildbot/}. @@ -704,8 +704,8 @@ are under @code{[MODULE-PLUGINNAME]} @subsubsection exported symbols @itemize @bullet -@item must start with "@code{GNUNET_modulename_}" and be defined in -"@file{modulename.c}" +@item must start with @code{GNUNET_modulename_} and be defined in +@file{modulename.c} @item exceptions: those defined in @file{gnunet_common.h} @end itemize @@ -1027,8 +1027,8 @@ export LD_LIBRARY_PATH=/path/to/gnunet/lib Ideally, any non-trivial GNUnet code should be covered by automated testcases. Testcases should reside in the same place as the code that is being tested. The name of source files implementing tests should begin -with "@code{test_}" followed by the name of the file -that contains the code that is being tested. +with @code{test_} followed by the name of the file that contains +the code that is being tested. Testcases in GNUnet should be integrated with the autotools build system. This way, developers and anyone building binary packages will be able to @@ -6955,7 +6955,7 @@ block plugin. In conclusion, GNUnet subsystems that want to use the DHT need to define a block format and write a plugin to match queries and replies. For testing, -the "@code{GNUNET_BLOCK_TYPE_TEST}" block type can be used; it accepts +the @code{GNUNET_BLOCK_TYPE_TEST} block type can be used; it accepts any query as valid and any reply as matching any query. This type is also used for the DHT command line tools. However, it should NOT be used for normal applications due to the lack diff --git a/doc/documentation/chapters/installation.texi b/doc/documentation/chapters/installation.texi index dfd94d037..a864d1c16 100644 --- a/doc/documentation/chapters/installation.texi +++ b/doc/documentation/chapters/installation.texi @@ -1882,7 +1882,7 @@ dlltool --input-def ../include/libmySQL.def \ @item Copy include\* to include\mysql\ -@item Pass "@code{--with-mysql=/c/mysql}" to +@item Pass @code{--with-mysql=/c/mysql} to @command{./configure} and copy @file{libmysql.dll} to your PATH or GNUnet's @file{bin} directory @end itemize @@ -2314,7 +2314,7 @@ support. How you build your peer with this options can be found here: @uref{https://gnunet.org/generic_installation} To configure your peer to act as a bootstrap server you have to add the -"@code{-p}" option to OPTIONS in the @code{[hostlist]} section of your +@code{-p} option to OPTIONS in the @code{[hostlist]} section of your configuration file. Besides that you have to specify a port number for the http server. In conclusion you have to add the following lines: @@ -2638,19 +2638,19 @@ strength of the adversary). @subsection Configuring logging Logging in GNUnet 0.9.0 is controlled via the "-L" and "-l" options. -Using "-L", a log level can be specified. With log level "@code{ERROR}" -only serious errors are logged. -The default log level is "@code{WARNING}" which causes anything of +Using @code{-L}, a log level can be specified. With log level +@code{ERROR} only serious errors are logged. +The default log level is @code{WARNING} which causes anything of concern to be logged. -Log level "@code{INFO}" can be used to log anything that might be +Log level @code{INFO} can be used to log anything that might be interesting information whereas -"@code{DEBUG}" can be used by developers to log debugging messages +@code{DEBUG} can be used by developers to log debugging messages (but you need to run @code{./configure} with @code{--enable-logging=verbose} to get them compiled). -The "-l" option is used to specify the log file. +The @code{-l} option is used to specify the log file. Since most GNUnet services are managed by @code{gnunet-arm}, using the -"-l" or "-L" options directly is not possible. +@code{-l} or @code{-L} options directly is not possible. Instead, they can be specified using the "OPTIONS" configuration value in the respective section for the respective service. In order to enable logging globally without editing the "OPTIONS" values @@ -3503,7 +3503,7 @@ However, even a @code{255.255.255.0} mask will suffice for most users. @subsubsection IPv6 address for interface The IPv6 address the VPN interface will get. Here you can specify any -non-link-local address (the address should not begin with "@code{fe80:}"). +non-link-local address (the address should not begin with @code{fe80:}). A subnet Unique Local Unicast (@code{fd00::/8} prefix) that you are currently not using would be a good choice. -- 2.25.1