gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] [gnunet] branch master updated (e2f0870ad -> 732816be4)


From: gnunet
Subject: [GNUnet-SVN] [gnunet] branch master updated (e2f0870ad -> 732816be4)
Date: Thu, 26 Oct 2017 15:02:45 +0200

This is an automated email from the git hooks/post-receive script.

ng0 pushed a change to branch master
in repository gnunet.

    from e2f0870ad documentation
     new 6667b33fd "@code{}" -> @code{}
     new fea7c5644 "@file{}" -> @file{}
     new 732816be4 @i{} -> @b{} and @{code} where appropriate

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 doc/documentation/chapters/developer.texi    | 21 +++++++++++----------
 doc/documentation/chapters/installation.texi | 22 +++++++++++-----------
 doc/documentation/gnunet-c-tutorial.texi     | 27 ++++++++++++++-------------
 3 files changed, 36 insertions(+), 34 deletions(-)

diff --git a/doc/documentation/chapters/developer.texi 
b/doc/documentation/chapters/developer.texi
index 9459068a9..87752a968 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
address@hidden Integration} system "@code{Buildbot}" is used
address@hidden 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
address@hidden must start with "@code{GNUNET_modulename_}" and be defined in
-"@file{modulename.c}"
address@hidden must start with @code{GNUNET_modulename_} and be defined in
address@hidden
 @item exceptions: those defined in @file{gnunet_common.h}
 @end itemize
 
@@ -726,7 +726,7 @@ in @file{src/include/}.
 @subsubsection testcases
 
 @itemize @bullet
address@hidden must be called "@file{test_module-under-test_case-description.c}"
address@hidden must be called @file{test_module-under-test_case-description.c}
 @item "case-description" maybe omitted if there is only one test
 @end itemize
 
@@ -735,7 +735,7 @@ in @file{src/include/}.
 @subsubsection performance tests
 
 @itemize @bullet
address@hidden must be called "@file{perf_module-under-test_case-description.c}"
address@hidden must be called @file{perf_module-under-test_case-description.c}
 @item "case-description" maybe omitted if there is only one performance
 test
 @item Must only be run if @code{HAVE_BENCHMARKS} is satisfied
@@ -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
@@ -1437,7 +1437,8 @@ Testbed API will then use this path to start helper 
binaries both
 locally and remotely.
 
 Testbed API can accessed by including the
-"@file{gnunet_testbed_service.h}" file and linking with -lgnunettestbed.
address@hidden file and linking with
address@hidden
 
 @c ***********************************************************************
 @menu
@@ -2929,7 +2930,7 @@ related functions provide an alternative to 
@code{GNUNET_SERVICE_run}.
 When starting a service, the service_name option is used to determine
 which sections in the configuration file should be used to configure the
 service. A typical value here is the name of the @file{src/}
-sub-directory, for example "@file{statistics}".
+sub-directory, for example @file{statistics}.
 The same string would also be given to
 @code{GNUNET_CLIENT_connect} to access the service.
 
@@ -6955,7 +6956,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..c3a64639b 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\ 
 
address@hidden  Pass "@code{--with-mysql=/c/mysql}" to
address@hidden  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
address@hidden 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:
@@ -2433,7 +2433,7 @@ FLUSH PRIVILEGES;
 @end example
 
 @item
-In the $HOME directory of $USER, create a "@file{.my.cnf}" file with the
+In the $HOME directory of $USER, create a @file{.my.cnf} file with the
 following lines
 
 @example
@@ -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
address@hidden 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
address@hidden 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.
address@hidden 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.
 
diff --git a/doc/documentation/gnunet-c-tutorial.texi 
b/doc/documentation/gnunet-c-tutorial.texi
index b62db7855..f39c7de64 100644
--- a/doc/documentation/gnunet-c-tutorial.texi
+++ b/doc/documentation/gnunet-c-tutorial.texi
@@ -163,7 +163,7 @@ and rerun the @code{gpg --verify-files} command.
 @b{Note:}@
 @b{The pub key to sign the 0.10.1 release has been
 revoked}. You will get an error message stating that
address@hidden is no known public key or that it has been revoked}.
address@hidden is no known public key or that it has been revoked}.
 The next release of GNUnet will have a valid signature
 again. We are sorry for the inconvenience this causes.
 Another possible source you could use is our
@@ -171,7 +171,7 @@ Another possible source you could use is our
 by every developer.
 
 Now you can extract the tarball and rename the resulting
-directory to @i{gnunet} which we will be using in the
+directory to @file{gnunet} which we will be using in the
 remainder of this document.
 
 @example
@@ -713,9 +713,10 @@ marked as ``done'' before their completion.
 
 An operation is treated as completed when it succeeds or fails.
 Completion of an operation is either conveyed as events through
address@hidden event callback} or through respective operation
-completion callbacks.  In functions which support completion
-notification through both controller event callback and operation
address@hidden event callback} or through respective
address@hidden completion callbacks}.
+In functions which support completion notification
+through both controller event callback and operation
 completion callback, first the controller event callback will be
 called.  If the operation is not marked as done in that callback
 or if the callback is given as NULL when creating the operation,
@@ -733,14 +734,14 @@ discouraged as their locations are dynamically created 
and will be
 different among various runs of testbed.  To make access to these
 configurations easy, testbed API provides the function
 @code{GNUNET\_TESTBED\_service\_connect()}.  This function fetches
-the configuration of a given peer and calls the @i{Connect Adapter}.
+the configuration of a given peer and calls the @dfn{Connect Adapter}.
 In the example code, it is the @code{dht\_ca}.  A connect adapter is
 expected to open the connection to the needed service by using the
 provided configuration and return the created service connection handle.
 Successful connection to the needed service is signaled through
 @code{service\_connect\_comp\_cb}.
 
-A dual to connect adapter is the @i{Disconnect Adapter}.  This callback
+A dual to connect adapter is the @dfn{Disconnect Adapter}.  This callback
 is called after the connect adapter has been called when the operation
 from @code{GNUNET\_TESTBED\_service\_connect()} is marked as ``done''.
 It has to disconnect from the service with the provided service
@@ -750,8 +751,8 @@ Exercise: Find out how many peers you can run on your 
system.
 
 Exercise: Find out how to create a 2D torus topology by changing the
 options in the configuration file.
-See @uref{https://gnunet.org/supported-topologies}, then use the
-DHT API to store and retrieve values in the network.
address@hidden Topologies, The GNUnet Reference Documentation ,, gnunet, The 
GNUnet Reference Documentation},
+then use the DHT API to store and retrieve values in the network.
 
 @node Developing Applications
 @chapter Developing Applications
@@ -1105,7 +1106,7 @@ peer to the service:
 
 @noindent
 Note that whatever you return from @code{connects} is given as the
address@hidden argument to the message handlers for messages from
address@hidden argument to the message handlers for messages from
 the respective peer.
 
 Exercise: Create a service that connects to the @code{CORE}.  Then
@@ -1116,7 +1117,7 @@ callback is invoked.
 @subsection Receiving P2P Messages
 
 To receive messages from @code{CORE}, you pass the desired
address@hidden to the @code{GNUNET\_CORE\_connect()} function,
address@hidden to the @code{GNUNET\_CORE\_connect()} function,
 just as we showed for services.
 
 It is your responsibility to process messages fast enough or
@@ -1132,8 +1133,8 @@ the two peers are connected?  Why?
 @node Sending P2P Messages
 @subsection Sending P2P Messages
 
-You can transmit messages to other peers using the @i{mq} you were
-given during the @code{connect} callback.  Note that the @i{mq}
+You can transmit messages to other peers using the @code{mq} you were
+given during the @code{connect} callback.  Note that the @code{mq}
 automatically is released upon @code{disconnect} and that you must
 not use it afterwards.
 

-- 
To stop receiving notification emails like this one, please contact
address@hidden



reply via email to

[Prev in Thread] Current Thread [Next in Thread]