diff options
author | ng0 <ng0@n0.is> | 2018-02-24 22:44:19 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2018-02-24 22:44:19 +0000 |
commit | d4ad64d79b26163f8bcd78d32fe463082b9ed8de (patch) | |
tree | 65141ab25829a86938c9dcbde67c0ba7da6e8d91 /doc | |
parent | b42e231bc946e96aa1c14628c11d0e109e88682a (diff) | |
download | gnunet-d4ad64d79b26163f8bcd78d32fe463082b9ed8de.tar.gz gnunet-d4ad64d79b26163f8bcd78d32fe463082b9ed8de.zip |
couple of markups in developer chap.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation/chapters/developer.texi | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/documentation/chapters/developer.texi b/doc/documentation/chapters/developer.texi index 0b8c7e488..41db89df8 100644 --- a/doc/documentation/chapters/developer.texi +++ b/doc/documentation/chapters/developer.texi | |||
@@ -815,8 +815,8 @@ Each variable type should be chosen with care. | |||
815 | statements (free, close, etc.) can be acceptable. | 815 | statements (free, close, etc.) can be acceptable. |
816 | 816 | ||
817 | @item Conditions should be written with constants on the left (to avoid | 817 | @item Conditions should be written with constants on the left (to avoid |
818 | accidental assignment) and with the 'true' target being either the | 818 | accidental assignment) and with the @code{true} target being either the |
819 | 'error' case or the significantly simpler continuation. For example: | 819 | @code{error} case or the significantly simpler continuation. For example: |
820 | 820 | ||
821 | @example | 821 | @example |
822 | if (0 != stat ("filename," &sbuf)) @{ | 822 | if (0 != stat ("filename," &sbuf)) @{ |
@@ -839,8 +839,8 @@ if (stat ("filename," &sbuf) == 0) @{ | |||
839 | @end example | 839 | @end example |
840 | 840 | ||
841 | @noindent | 841 | @noindent |
842 | If possible, the error clause should be terminated with a 'return' (or | 842 | If possible, the error clause should be terminated with a @code{return} (or |
843 | 'goto' to some cleanup routine) and in this case, the 'else' clause | 843 | @code{goto} to some cleanup routine) and in this case, the @code{else} clause |
844 | should be omitted: | 844 | should be omitted: |
845 | 845 | ||
846 | @example | 846 | @example |
@@ -2159,7 +2159,7 @@ any attempts to make the same call later will be allowed or disallowed | |||
2159 | right away. Because of that runtime log level evaluation should not | 2159 | right away. Because of that runtime log level evaluation should not |
2160 | significantly affect the process performance. | 2160 | significantly affect the process performance. |
2161 | Log definition parsing is only done once, at the first call to | 2161 | Log definition parsing is only done once, at the first call to |
2162 | GNUNET_log_setup () made by the process (which is usually done soon after | 2162 | @code{GNUNET_log_setup ()} made by the process (which is usually done soon after |
2163 | it starts). | 2163 | it starts). |
2164 | 2164 | ||
2165 | At the moment of writing there is no way to specify logging definitions | 2165 | At the moment of writing there is no way to specify logging definitions |
@@ -2323,18 +2323,21 @@ topology\n")); #endif unblacklisted_connections = create_small_world_ring | |||
2323 | Pretty hard to follow, huh? | 2323 | Pretty hard to follow, huh? |
2324 | 2324 | ||
2325 | From now on, it is not necessary to include the #if / #endif statements to | 2325 | From now on, it is not necessary to include the #if / #endif statements to |
2326 | achieve the same behavior. The GNUNET_log and GNUNET_log_from macros take | 2326 | achieve the same behavior. The @code{GNUNET_log} and @code{GNUNET_log_from} |
2327 | macros take | ||
2327 | care of it for you, depending on the configure option: | 2328 | care of it for you, depending on the configure option: |
2328 | 2329 | ||
2329 | @itemize @bullet | 2330 | @itemize @bullet |
2330 | @item If @code{--enable-logging} is set to @code{no}, the binary will | 2331 | @item If @code{--enable-logging} is set to @code{no}, the binary will |
2331 | contain no log messages at all. | 2332 | contain no log messages at all. |
2332 | @item If @code{--enable-logging} is set to @code{yes}, the binary will | 2333 | @item If @code{--enable-logging} is set to @code{yes}, the binary will |
2333 | contain no DEBUG messages, and therefore running with -L DEBUG will have | 2334 | contain no DEBUG messages, and therefore running with @command{-L DEBUG} |
2335 | will have | ||
2334 | no effect. Other messages (ERROR, WARNING, INFO, etc) will be included. | 2336 | no effect. Other messages (ERROR, WARNING, INFO, etc) will be included. |
2335 | @item If @code{--enable-logging} is set to @code{verbose}, or | 2337 | @item If @code{--enable-logging} is set to @code{verbose}, or |
2336 | @code{veryverbose} the binary will contain DEBUG messages (still, it will | 2338 | @code{veryverbose} the binary will contain DEBUG messages (still, it will |
2337 | be neccessary to run with -L DEBUG or set the DEBUG config option to show | 2339 | be neccessary to run with @command{-L DEBUG} or set the DEBUG config option |
2340 | to show | ||
2338 | them). | 2341 | them). |
2339 | @end itemize | 2342 | @end itemize |
2340 | 2343 | ||