From b996ba4156678b6a0a551b9a932867b2ade42344 Mon Sep 17 00:00:00 2001 From: Alessio Vanni Date: Sat, 24 Apr 2021 17:30:45 +0200 Subject: -Fix several incorrect uses of `i.e.' With some other changes to sentences here and there as I found appropriate. --- README.1st | 2 +- doc/handbook/chapters/developer.texi | 53 +++++++++++----------- doc/handbook/chapters/installation.texi | 19 ++++---- doc/handbook/chapters/user.texi | 14 +++--- doc/man/gnunet-config.1 | 2 +- doc/man/gnunet-datastore.1 | 2 +- doc/man/gnunet-namestore.1 | 2 +- src/abd/plugin_gnsrecord_abd.c | 4 +- src/conversation/plugin_gnsrecord_conversation.c | 4 +- src/curl/curl.c | 4 +- src/datacache/datacache.c | 4 +- src/datastore/gnunet-service-datastore.c | 4 +- src/dht/dht_api.c | 2 +- src/dht/gnunet-service-dht_clients.c | 2 +- src/fragmentation/test_fragmentation.c | 2 +- src/fragmentation/test_fragmentation_parallel.c | 2 +- src/fs/fs_directory.c | 2 +- src/fs/fs_download.c | 2 +- src/fs/fs_sharetree.c | 2 +- src/fs/fs_uri.c | 2 +- src/fs/gnunet-helper-fs-publish.c | 2 +- src/fs/gnunet-search.c | 2 +- src/fs/perf_gnunet_service_fs_p2p_respect.c | 2 +- src/gns/gns_tld_api.c | 2 +- src/gns/gnunet-gns-import.c | 13 +++--- src/gns/gnunet-gns-proxy-ca.template | 4 +- src/gns/gnunet-gns-proxy.c | 4 +- src/gns/gnunet-service-gns.c | 2 +- src/gns/gnunet-service-gns_resolver.c | 4 +- src/gns/plugin_gnsrecord_gns.c | 4 +- src/gnsrecord/gnsrecord.c | 4 +- src/gnsrecord/plugin_gnsrecord_dns.c | 4 +- src/hostlist/gnunet-daemon-hostlist_server.c | 4 +- src/identity/gnunet-identity.c | 13 +++--- src/include/gnunet_ats_service.h | 6 +-- src/include/gnunet_ats_transport_service.h | 2 +- src/include/gnunet_client_lib.h | 2 +- src/include/gnunet_container_lib.h | 8 ++-- src/include/gnunet_crypto_lib.h | 4 +- src/include/gnunet_curl_lib.h | 2 +- src/include/gnunet_dht_service.h | 2 +- src/include/gnunet_getopt_lib.h | 2 +- src/include/gnunet_gnsrecord_lib.h | 4 +- src/include/gnunet_gnsrecord_plugin.h | 6 +-- src/include/gnunet_identity_service.h | 15 +++--- src/include/gnunet_mq_lib.h | 8 ++-- src/include/gnunet_network_lib.h | 2 +- src/include/gnunet_reclaim_plugin.h | 12 ++--- src/include/gnunet_strings_lib.h | 8 ++-- src/include/gnunet_testbed_service.h | 6 +-- src/include/gnunet_time_lib.h | 2 +- .../gnunet_transport_communication_service.h | 6 +-- src/include/gnunet_transport_plugin.h | 2 +- src/include/gnunet_tun_lib.h | 4 +- src/namestore/gnunet-namestore-fcfsd.c | 15 +++--- src/namestore/gnunet-zoneimport.c | 13 +++--- src/peerinfo-tool/gnunet-peerinfo_plugins.c | 4 +- src/pt/test_gns_vpn.c | 13 +++--- src/reclaim/plugin_gnsrecord_reclaim.c | 4 +- src/reclaim/plugin_reclaim_attribute_basic.c | 2 +- src/reclaim/plugin_reclaim_credential_jwt.c | 2 +- src/reclaim/plugin_rest_openid_connect.c | 13 +++--- src/reclaim/plugin_rest_reclaim.c | 13 +++--- src/rest/gnunet-rest-server.c | 2 +- src/testbed/testbed_api.c | 2 +- src/testbed/testbed_api_test.c | 2 +- src/testbed/testbed_api_testbed.c | 2 +- src/testing/testing.c | 2 +- src/transport/gnunet-helper-transport-bluetooth.c | 2 +- src/transport/gnunet-helper-transport-wlan.c | 2 +- src/transport/gnunet-service-transport_plugins.c | 4 +- src/util/client.c | 2 +- src/util/container_meta_data.c | 4 +- src/util/crypto_rsa.c | 2 +- src/util/network.c | 2 +- src/util/scheduler.c | 2 +- src/util/strings.c | 8 ++-- src/util/tun.c | 4 +- 78 files changed, 205 insertions(+), 213 deletions(-) diff --git a/README.1st b/README.1st index c25992351..073357466 100644 --- a/README.1st +++ b/README.1st @@ -13,7 +13,7 @@ impact are given with each item. ats: * We currently select one transport per peer, but we should allow the -use of multiple channels concurrently (i.e. UDP + TCP at the same +use of multiple channels concurrently (e.g. UDP + TCP at the same time). Neither ATS nor transport support this today, and this requires a major change in the ATS plugins and the ATS API and the overall ATS/transport logic. [6-12 PM, robustness, performance] diff --git a/doc/handbook/chapters/developer.texi b/doc/handbook/chapters/developer.texi index e7b88a39f..1bf7a7b24 100644 --- a/doc/handbook/chapters/developer.texi +++ b/doc/handbook/chapters/developer.texi @@ -392,9 +392,9 @@ etc.). @item @file{transport/} --- transport service The transport service is responsible for managing the basic P2P communication. It uses plugins to support P2P communication -over TCP, UDP, HTTP, HTTPS and other protocols.The transport service +over TCP, UDP, HTTP, HTTPS and other protocols. The transport service validates peer addresses, enforces bandwidth restrictions, limits the -total number of connections and enforces connectivity restrictions (i.e. +total number of connections and enforces connectivity restrictions (e.g. friends-only). @item @file{peerinfo-tool/} --- gnunet-peerinfo This directory contains the gnunet-peerinfo binary which can be used to @@ -746,21 +746,21 @@ Here you can find some rules to help you write code for GNUnet. @itemize @bullet @item services and daemons use their directory name in -@code{GNUNET_log_setup} (i.e. 'core') and log using +@code{GNUNET_log_setup} (e.g. 'core') and log using plain 'GNUNET_log'. @item command-line tools use their full name in -@code{GNUNET_log_setup} (i.e. 'gnunet-publish') and log using +@code{GNUNET_log_setup} (e.g. 'gnunet-publish') and log using plain 'GNUNET_log'. @item service access libraries log using '@code{GNUNET_log_from}' and use '@code{DIRNAME-api}' for the -component (i.e. 'core-api') +component (e.g. 'core-api') @item pure libraries (without associated service) use '@code{GNUNET_log_from}' with the component set to their library name (without lib or '@file{.so}'), -which should also be their directory name (i.e. '@file{nat}') +which should also be their directory name (e.g. '@file{nat}') @item plugins should use '@code{GNUNET_log_from}' with the directory name and the plugin name combined to produce -the component name (i.e. 'transport-tcp'). +the component name (e.g. 'transport-tcp'). @item logging should be unified per-file by defining a @code{LOG} macro with the appropriate arguments, along these lines: @@ -832,14 +832,14 @@ test @subsubsection src/ directories @itemize @bullet -@item gnunet-NAME: end-user applications (i.e., gnunet-search, gnunet-arm) -@item gnunet-service-NAME: service processes with accessor library (i.e., +@item gnunet-NAME: end-user applications (like gnunet-search or gnunet-arm) +@item gnunet-service-NAME: service processes with accessor library (e.g. gnunet-service-arm) @item libgnunetNAME: accessor library (_service.h-header) or standalone library (_lib.h-header) -@item gnunet-daemon-NAME: daemon process without accessor library (i.e., +@item gnunet-daemon-NAME: daemon process without accessor library (e.g. gnunet-daemon-hostlist) and no GNUnet management port -@item libgnunet_plugin_DIR_NAME: loadable plugins (i.e., +@item libgnunet_plugin_DIR_NAME: loadable plugins (e.g. libgnunet_plugin_transport_tcp) @end itemize @@ -6640,7 +6640,7 @@ The size of an element's data is limited to around 62 KB. Sets created by a local client can be modified and reused for multiple operations. As each set operation requires potentially expensive special auxiliary data to be computed for each element of a set, a set can only -participate in one type of set operation (i.e. union or intersection). +participate in one type of set operation (either union or intersection). The type of a set is determined upon its creation. If a the elements of a set are needed for an operation of a different type, all of the set's element must be copied to a new set of appropriate @@ -9030,14 +9030,13 @@ particular key has been revoked. The service responds with a @code{QueryResponseMessage} which simply contains a bit that says if the given public key is still valid, or if it has been revoked. -The second possible interaction is for a client to revoke a key by -passing a @code{RevokeMessage} to the service. The @code{RevokeMessage} -contains the ECDSA public key to be revoked, a signature by the -corresponding private key and the proof-of-work, The service responds -with a @code{RevocationResponseMessage} which can be used to indicate -that the @code{RevokeMessage} was invalid (i.e. proof of work incorrect), -or otherwise indicates that the revocation has been processed -successfully. +The second possible interaction is for a client to revoke a key by passing a +@code{RevokeMessage} to the service. The @code{RevokeMessage} contains the +ECDSA public key to be revoked, a signature by the corresponding private key +and the proof-of-work. The service responds with a +@code{RevocationResponseMessage} which can be used to indicate that the +@code{RevokeMessage} was invalid (e.g. the proof of work is incorrect), or +otherwise to indicate that the revocation has been processed successfully. @node The REVOCATION Peer-to-Peer Protocol @subsection The REVOCATION Peer-to-Peer Protocol @@ -9615,9 +9614,9 @@ In order to address the above issues, we want to: TRANSPORT shall create bi-directional channels from this whenever possible. @item DV should no longer be a plugin, but part of TRANSPORT. -@item TRANSPORT should provide communicators help communicating (i.e. in the - case of uni-directional communicators or the need for out-of-band - signalling for NAT traversal). We call this functionality +@item TRANSPORT should provide communicators help communicating, for example + in the case of uni-directional communicators or the need for out-of-band + signalling for NAT traversal. We call this functionality @emph{backchannels}. @item Transport manipulation should be signalled to CORE on a per-message basis instead of an approximate bandwidth. @@ -9715,8 +9714,8 @@ by layer. For example, CADET will always strictly implement reliable and in-order delivery of messages, while the same options are only advisory for TRANSPORT and CORE: they should try (using ACKs on unreliable communicators, not changing the message order themselves), but if messages are lost anyway -(i.e. because a TCP is dropped in the middle), or if messages are reordered -(i.e. because they took dierent paths over the network and arrived in a +(e.g. because a TCP is dropped in the middle), or if messages are reordered +(e.g. because they took different paths over the network and arrived in a different order) TRANSPORT and CORE do not have to correct this. Whether a preference is strict or loose is thus dened by the respective layer. @@ -9728,8 +9727,8 @@ The API for communicators is defined in Each communicator must specify its (global) communication characteristics, which for now only say whether the communication is reliable (e.g. TCP, HTTPS) or unreliable (e.g. UDP, WLAN). Each communicator must specify a unique address -prex, or NULL if the communicator cannot establish outgoing connections (i.e. -is only acting as a TCP server). +prex, or NULL if the communicator cannot establish outgoing connections +(for example because it is only acting as a TCP server). A communicator must tell TRANSPORT which addresses it is reachable under. Addresses may be added or removed at any time. A communicator may have zero addresses (transmission only). diff --git a/doc/handbook/chapters/installation.texi b/doc/handbook/chapters/installation.texi index ad939b5b7..24431e20f 100644 --- a/doc/handbook/chapters/installation.texi +++ b/doc/handbook/chapters/installation.texi @@ -1355,7 +1355,7 @@ The interface channel depends on the wlan network that the card is connected to. If no connection has been made since the start of the computer, it is usually the first channel of the card. Peers will only find each other and communicate if they are on the same -channel. Channels must be set manually, i.e. using: +channel. Channels must be set manually, e.g. by using: @example iwconfig wlan0 channel 1 @@ -1944,12 +1944,13 @@ Python installation and its dependencies. Another way to install Ascension on Debian is to install the python3-ascension package. It can be found within the above mentioned Ascension git repository. -This also adds a system user ascension and runs a GNUnet peer in the -background. Attention: This only works if a recent version of GNUnet is +This also adds a system user called ascension and runs a GNUnet peer in the +background. Please note: This only works if a recent version of GNUnet is installed on your system. The version number of Ascension is chosen according -to the required feature level of GNUnet. I.e. Ascension 0.11.5 is only -compatible with GNUnet 0.11.5 and upwards. As Debian's packages for GNUnet are -outdated even in experimental, you will need to install GNUnet manually +to the required feature level of GNUnet: Ascension 0.11.5 is only +compatible with GNUnet 0.11.5 or later and so on. +As Debian's packages for GNUnet are outdated even in experimental, +you will need to install GNUnet manually @xref{Installing GNUnet}. Please check @xref{Migrating an existing DNS zone into GNS}, for usage manual @@ -2034,11 +2035,11 @@ Furthermore, you can serve as a DNS, IPv4 or IPv6 exit to the Internet. Being a DNS exit is usually pretty harmless. However, enabling IPv4 or IPv6-exit without further precautions may enable adversaries to access your local network, send spam, attack other systems from your Internet -connection and to other mischief that will appear to come from your +connection and do other mischiefs that will appear to come from your machine. This may or may not get you into legal trouble. If you want to allow IPv4 or IPv6-exit functionality, you should strongly consider adding additional firewall rules manually to protect your local -network and to restrict outgoing TCP traffic (i.e. by not allowing access +network and to restrict outgoing TCP traffic (e.g. by not allowing access to port 25). While we plan to improve exit-filtering in the future, you're currently on your own here. Essentially, be prepared for any kind of IP-traffic to exit the respective @@ -2159,7 +2160,7 @@ run as use "gnunet" (and with option "-c /etc/gnunet.conf" so that it modifies the system configuration). As always, gnunet-setup should be run after the GNUnet peer was stopped using "gnunet-arm -e". Distributors might want to include a wrapper for gnunet-setup that allows the -desktop-user to "sudo" (i.e. using gtksudo) to the "gnunet" user account +desktop-user to "sudo" (e.g. using gtksudo) to the "gnunet" user account and then runs "gnunet-arm -e", "gnunet-setup" and "gnunet-arm -s" in sequence. diff --git a/doc/handbook/chapters/user.texi b/doc/handbook/chapters/user.texi index 911d23526..409a89e47 100644 --- a/doc/handbook/chapters/user.texi +++ b/doc/handbook/chapters/user.texi @@ -71,7 +71,7 @@ $ gnunet-arm -e ``.pin'' is a default zone which points to a zone managed by gnunet.org. Use @code{gnunet-config -s gns} to view the GNS configuration, including all configured zones that are operated by other users. The respective -configuration entry names start with a ``.'', i.e. ``.pin''. +configuration entry names start with a ``.'', e.g. ``.pin''. You can configure any number of top-level domains, and point them to the respective zones of your friends! For this, simply obtain the @@ -1620,7 +1620,7 @@ under "*.friend.gnu". BOX records are there to integrate information from TLSA or SRV records under the main label. In DNS, TLSA and SRV records use special names of the form @code{_port._proto.(label.)*tld} to -indicate the port number and protocol (i.e. tcp or udp) for which +indicate the port number and protocol (like TCP or UDP) for which the TLSA or SRV record is valid. This causes various problems, and is elegantly solved in GNS by integrating the protocol and port numbers together with the respective value into a "BOX" record. @@ -1700,7 +1700,7 @@ be useful if you do not want to start resolution in the DNS root zone (due to issues such as censorship or availability). Note that you would typically want to use a relative name for the -nameserver, i.e. +nameserver, like so: @example Name: pet; RRType: GNS2DNS; Value: gnunet.org@@ns-joker.+@ @@ -2244,7 +2244,7 @@ that subnet to the GNUnet exit's TUN interface. When running a local service, you should make sure that the local service is (also) bound to the IP address of your EXIT interface -(i.e. 169.254.86.1). It will NOT work if your local service is +(e.g. 169.254.86.1). It will NOT work if your local service is just bound to loopback. You may also want to create a "VPN" record in your zone of the GNU Name System to make it easy for others to access your service via a name instead of just the full service @@ -2315,7 +2315,7 @@ and restart your peer, your Internet traffic should be tunneled over the GNUnet VPN. The GNUnet VPN uses DNS-ALG to hijack your IP traffic. Whenever an -application resolves a hostname (i.e. 'gnunet.org'), the +application resolves a hostname (like 'gnunet.org'), the "gnunet-daemon-pt" will instruct the "gnunet-service-dns" to intercept the request (possibly route it over GNUnet as well) and replace the normal answer with an IP in the range of the VPN's interface. @@ -2325,8 +2325,8 @@ destination. For applications that do not use DNS, you can also manually create such a mapping using the gnunet-vpn command-line tool. Here, you -specify the desired address family of the result (i.e. "-4"), and the -intended target IP on the Internet ("-i 131.159.74.67") and +specify the desired address family of the result (e.g. "-4"), and the +intended target IP on the Internet (e.g. "-i 131.159.74.67") and "gnunet-vpn" will tell you which IP address in the range of your VPN tunnel was mapped. diff --git a/doc/man/gnunet-config.1 b/doc/man/gnunet-config.1 index 89bc3d14b..3d243af89 100644 --- a/doc/man/gnunet-config.1 +++ b/doc/man/gnunet-config.1 @@ -45,7 +45,7 @@ can be used to read or modify GNUnet configuration files. .Bl -tag -width indent .It Fl b Ar BACKEND | Fl -supported-backend= Ns Ar BACKEND -Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, i.e. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error). +Tests whether the specified BACKEND is supported by the current installation. The backend must match the name of a plugin, e.g. "namestore_postgres" for the Postgres database backend of the "NAMESTORE" service. If the BACKEND is supported, gnunet-config will return a status code of 0 (success), otherwise 77 (unsupported). When this option is specified, no other options may be specified. Specifying this option together with other options will cause gnunet-config to return a status code of 1 (error). .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME Use the configuration file FILENAME. .It Fl f | -filename diff --git a/doc/man/gnunet-datastore.1 b/doc/man/gnunet-datastore.1 index 81347dcae..842ba62a0 100644 --- a/doc/man/gnunet-datastore.1 +++ b/doc/man/gnunet-datastore.1 @@ -41,7 +41,7 @@ .Nm can be used to backup and restore or merge GNUnet datastores. This is useful if a datastore is to be migrated between -SQL databases, i.e. from sqlite to postgres or vice versa. +SQL databases, e.g. from sqlite to postgres or vice versa. gnunet-datastore will dump the entire contents of the database or insert a dump file into the database. .Bl -tag -width indent diff --git a/doc/man/gnunet-namestore.1 b/doc/man/gnunet-namestore.1 index b9bbff027..73bbe5a5c 100644 --- a/doc/man/gnunet-namestore.1 +++ b/doc/man/gnunet-namestore.1 @@ -109,7 +109,7 @@ Create a record that is a shadow record. Shadow records are only used once all other records of the same type under the same label have expired. .It Fl t Ar TYPE | Fl -type= Ns Ar TYPE -Type of the record to add/delete/display (i.e. "A", "AAAA", "NS", "PKEY", "MX" etc.). +Type of the record to add/delete/display ("A"; "AAAA"; "NS"; "PKEY"; "MX"; etc.). .It Fl u Ar URI | Fl -uri= Ns Ar URI Add PKEY record from gnunet://gns/-URI to our zone; the record type is always PKEY, if no expiration is given FOREVER is used diff --git a/src/abd/plugin_gnsrecord_abd.c b/src/abd/plugin_gnsrecord_abd.c index 272872e24..25dc20152 100644 --- a/src/abd/plugin_gnsrecord_abd.c +++ b/src/abd/plugin_gnsrecord_abd.c @@ -276,7 +276,7 @@ static struct /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param cls closure, unused * @param gns_typename name to convert @@ -296,7 +296,7 @@ abd_typename_to_number (void *cls, const char *gns_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/conversation/plugin_gnsrecord_conversation.c b/src/conversation/plugin_gnsrecord_conversation.c index 2ea2f48f0..786711c8e 100644 --- a/src/conversation/plugin_gnsrecord_conversation.c +++ b/src/conversation/plugin_gnsrecord_conversation.c @@ -179,7 +179,7 @@ static struct /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param cls closure, unused * @param gns_typename name to convert @@ -201,7 +201,7 @@ conversation_typename_to_number (void *cls, /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/curl/curl.c b/src/curl/curl.c index deb14a926..949b9a1b0 100644 --- a/src/curl/curl.c +++ b/src/curl/curl.c @@ -697,7 +697,7 @@ GNUNET_CURL_job_cancel (struct GNUNET_CURL_Job *job) /** * Test if the given content type @a ct is JSON * - * @param ct a content type, i.e. "application/json; charset=UTF-8" + * @param ct a content type, e.g. "application/json; charset=UTF-8" * @return true if @a ct denotes JSON */ static bool @@ -741,7 +741,7 @@ is_json (const char *ct) * @param db download buffer * @param eh CURL handle (to get the response code) * @param[out] response_code set to the HTTP response code - * (or zero if we aborted the download, i.e. + * (or zero if we aborted the download, for example * because the response was too big, or if * the JSON we received was malformed). * @return NULL if downloading a JSON reply failed. diff --git a/src/datacache/datacache.c b/src/datacache/datacache.c index 5fc5a7481..331a9b784 100644 --- a/src/datacache/datacache.c +++ b/src/datacache/datacache.c @@ -66,12 +66,12 @@ struct GNUNET_DATACACHE_Handle struct GNUNET_DATACACHE_PluginFunctions *api; /** - * Short name for the plugin (i.e. "sqlite"). + * Short name for the plugin (e.g. "sqlite"). */ char *short_name; /** - * Name of the library (i.e. "gnunet_plugin_datacache_sqlite"). + * Name of the library (e.g. "gnunet_plugin_datacache_sqlite"). */ char *lib_name; diff --git a/src/datastore/gnunet-service-datastore.c b/src/datastore/gnunet-service-datastore.c index 1c9e5e463..97888ce03 100644 --- a/src/datastore/gnunet-service-datastore.c +++ b/src/datastore/gnunet-service-datastore.c @@ -84,12 +84,12 @@ struct DatastorePlugin struct GNUNET_DATASTORE_PluginFunctions *api; /** - * Short name for the plugin (i.e. "sqlite"). + * Short name for the plugin (e.g. "sqlite"). */ char *short_name; /** - * Name of the library (i.e. "gnunet_plugin_datastore_sqlite"). + * Name of the library (e.g. "gnunet_plugin_datastore_sqlite"). */ char *lib_name; diff --git a/src/dht/dht_api.c b/src/dht/dht_api.c index ffcfba997..96399cb5a 100644 --- a/src/dht/dht_api.c +++ b/src/dht/dht_api.c @@ -1026,7 +1026,7 @@ GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, * has not yet been sent to the service, cancelling the PUT will stop * this from happening (but there is no way for the user of this API * to tell if that is the case). The only use for this API is to - * prevent a later call to 'cont' from #GNUNET_DHT_put (i.e. because + * prevent a later call to 'cont' from #GNUNET_DHT_put (e.g. because * the system is shutting down). * * @param ph put operation to cancel ('cont' will no longer be called) diff --git a/src/dht/gnunet-service-dht_clients.c b/src/dht/gnunet-service-dht_clients.c index dfa8ee380..cfcb25336 100644 --- a/src/dht/gnunet-service-dht_clients.c +++ b/src/dht/gnunet-service-dht_clients.c @@ -1482,7 +1482,7 @@ GDS_CLIENTS_stop () /** * Define "main" method using service macro. * - * @param name name of the service, i.e. "dht" or "xdht" + * @param name name of the service, like "dht" or "xdht" * @param run name of the initializaton method for the service */ #define GDS_DHT_SERVICE_INIT(name, run) \ diff --git a/src/fragmentation/test_fragmentation.c b/src/fragmentation/test_fragmentation.c index 4c71e0195..77879f75b 100644 --- a/src/fragmentation/test_fragmentation.c +++ b/src/fragmentation/test_fragmentation.c @@ -108,7 +108,7 @@ proc_msgs (void *cls, const struct GNUNET_MessageHeader *hdr) if (0 == (total % (NUM_MSGS / 100))) fprintf (stderr, "%s", "."); #endif - /* tolerate 10% loss, i.e. due to duplicate fragment IDs */ + /* tolerate 10% loss, e.g. due to duplicate fragment IDs */ if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) { if (NULL == shutdown_task) diff --git a/src/fragmentation/test_fragmentation_parallel.c b/src/fragmentation/test_fragmentation_parallel.c index 000ca60d2..d19296cf5 100644 --- a/src/fragmentation/test_fragmentation_parallel.c +++ b/src/fragmentation/test_fragmentation_parallel.c @@ -100,7 +100,7 @@ proc_msgs (void *cls, const struct GNUNET_MessageHeader *hdr) if (0 == (total % (NUM_MSGS / 100))) fprintf (stderr, "%s", "."); #endif - /* tolerate 10% loss, i.e. due to duplicate fragment IDs */ + /* tolerate 10% loss, e.g due to duplicate fragment IDs */ if ((total >= NUM_MSGS - (NUM_MSGS / 10)) && (ret != 0)) { if (NULL == shutdown_task) diff --git a/src/fs/fs_directory.c b/src/fs/fs_directory.c index 9a198d8d7..9f0f12611 100644 --- a/src/fs/fs_directory.c +++ b/src/fs/fs_directory.c @@ -120,7 +120,7 @@ struct GetFullDataClosure * * @param cls closure (user-defined) * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c index d4677b794..1f8ce7c05 100644 --- a/src/fs/fs_download.c +++ b/src/fs/fs_download.c @@ -586,7 +586,7 @@ try_match_block (struct GNUNET_FS_DownloadContext *dc, * * @param cls our 'struct GNUNET_FS_DownloadContext*' * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/fs_sharetree.c b/src/fs/fs_sharetree.c index ac850076d..d5e75f9be 100644 --- a/src/fs/fs_sharetree.c +++ b/src/fs/fs_sharetree.c @@ -183,7 +183,7 @@ add_to_keyword_counter (void *cls, const char *keyword, int is_mandatory) * * @param cls the container multihashmap to update * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c index a9afff3e8..4d1b7c6f0 100644 --- a/src/fs/fs_uri.c +++ b/src/fs/fs_uri.c @@ -1691,7 +1691,7 @@ get_keywords_from_tokens (const char *s, char **array, int index) * * @param cls URI to update * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/gnunet-helper-fs-publish.c b/src/fs/gnunet-helper-fs-publish.c index 5d2d1229b..ef1a9ce4b 100644 --- a/src/fs/gnunet-helper-fs-publish.c +++ b/src/fs/gnunet-helper-fs-publish.c @@ -100,7 +100,7 @@ static int output_stream; * * @param cls closure, our meta data container * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/gnunet-search.c b/src/fs/gnunet-search.c index e49609b18..3bf013650 100644 --- a/src/fs/gnunet-search.c +++ b/src/fs/gnunet-search.c @@ -64,7 +64,7 @@ static struct GNUNET_SCHEDULER_Task *tt; * * @param cls closure (user-defined, unused) * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/fs/perf_gnunet_service_fs_p2p_respect.c b/src/fs/perf_gnunet_service_fs_p2p_respect.c index b7fe61be7..c48db2383 100644 --- a/src/fs/perf_gnunet_service_fs_p2p_respect.c +++ b/src/fs/perf_gnunet_service_fs_p2p_respect.c @@ -21,7 +21,7 @@ /** * @file fs/perf_gnunet_service_fs_p2p_respect.c * @brief profile P2P routing respect mechanism. Creates - * a clique of NUM_DAEMONS (i.e. 3) where two + * a clique of NUM_DAEMONS (at least 3) where two * peers share (seed) different files and download * them from each other while all the other peers * just "leach" those files. Ideally, the seeders diff --git a/src/gns/gns_tld_api.c b/src/gns/gns_tld_api.c index b883662ad..1b711cf40 100644 --- a/src/gns/gns_tld_api.c +++ b/src/gns/gns_tld_api.c @@ -235,7 +235,7 @@ identity_zone_cb (void *cls, * @param options local options for the lookup * @param proc processor to call on result * @param proc_cls closure for @a proc - * @return handle to the get request, NULL on error (i.e. bad configuration) + * @return handle to the get request, NULL on error (e.g. bad configuration) */ struct GNUNET_GNS_LookupWithTldRequest * GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle, diff --git a/src/gns/gnunet-gns-import.c b/src/gns/gnunet-gns-import.c index 972fb49cd..e99c4d3dd 100644 --- a/src/gns/gnunet-gns-import.c +++ b/src/gns/gnunet-gns-import.c @@ -272,13 +272,12 @@ zone_iteration_finished (void *cls) * with 'NULL' for 'ego'. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', - * this function is only called ONCE, and 'NULL' being passed in - * 'ego' does indicate an error (i.e. name is taken or no default - * value is known). If 'ego' is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of 'GNUNET_IDENTITY_connect' (if - * that one was not NULL). + * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this + * function is only called ONCE, and 'NULL' being passed in 'ego' does + * indicate an error (for example because name is taken or no default value is + * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * 'GNUNET_IDENTITY_connect' (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) ego but the NEW identifier. diff --git a/src/gns/gnunet-gns-proxy-ca.template b/src/gns/gnunet-gns-proxy-ca.template index 32ee27fcd..541e3a355 100644 --- a/src/gns/gnunet-gns-proxy-ca.template +++ b/src/gns/gnunet-gns-proxy-ca.template @@ -51,7 +51,7 @@ cn = "GNS Proxy CA" #dn = "cn = Nikos,st = New\, Something,C=GR,surName=Mavrogiannopoulos,2.5.4.9=Arkadias" # The serial number of the certificate -# The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). +# The value is in decimal (e.g. 1963) or hex (e.g. 0x07ab). # Comment the field for a random serial number. #serial = 007 @@ -283,7 +283,7 @@ tls_www_server #crl_next_update = 43 # this is the 5th CRL by this CA -# The value is in decimal (i.e. 1963) or hex (i.e. 0x07ab). +# The value is in decimal (e.g. 1963) or hex (e.g. 0x07ab). # Comment the field for a time-based number. # Time-based CRL numbers generated in GnuTLS 3.6.3 and later # are significantly larger than those generated in previous diff --git a/src/gns/gnunet-gns-proxy.c b/src/gns/gnunet-gns-proxy.c index d02f0f576..5e3f9d6df 100644 --- a/src/gns/gnunet-gns-proxy.c +++ b/src/gns/gnunet-gns-proxy.c @@ -1811,7 +1811,7 @@ con_val_iter (void *cls, * @param con MHD connection handle * @param url the url in the request * @param meth the HTTP method used ("GET", "PUT", etc.) - * @param ver the HTTP version string (i.e. "HTTP/1.1") + * @param ver the HTTP version string ("HTTP/1.1" for version 1.1, etc.) * @param upload_data the data being uploaded (excluding HEADERS, * for a POST that fits into memory and that is encoded * with a supported encoding, the POST data will NOT be @@ -2855,7 +2855,7 @@ lookup_ssl_httpd (const char*domain) /** * Task run when a Socks5Request somehow fails to be associated with - * an MHD connection (i.e. because the client never speaks HTTP after + * an MHD connection (e.g. because the client never speaks HTTP after * the SOCKS5 handshake). Clean up. * * @param cls the `struct Socks5Request *` diff --git a/src/gns/gnunet-service-gns.c b/src/gns/gnunet-service-gns.c index 52300ae3b..5833f4d0b 100644 --- a/src/gns/gnunet-service-gns.c +++ b/src/gns/gnunet-service-gns.c @@ -104,7 +104,7 @@ struct GnsClient /** * Representation of a TLD, mapping the respective TLD string - * (i.e. ".gnu") to the respective public key of the zone. + * (e.g. ".gnu") to the respective public key of the zone. */ struct GNS_TopLevelDomain { diff --git a/src/gns/gnunet-service-gns_resolver.c b/src/gns/gnunet-service-gns_resolver.c index 2f8a55804..784a6ee6d 100644 --- a/src/gns/gnunet-service-gns_resolver.c +++ b/src/gns/gnunet-service-gns_resolver.c @@ -418,7 +418,7 @@ struct GNS_ResolverHandle /** * We increment the loop limiter for each step in a recursive - * resolution. If it passes our @e loop_threshold (i.e. due to + * resolution. If it passes our @e loop_threshold (e.g. due to * self-recursion in the resolution, i.e CNAME fun), we stop. */ unsigned int loop_limiter; @@ -516,7 +516,7 @@ static const struct GNUNET_CONFIGURATION_Handle *cfg; /** * Determine if this name is canonical (is a legal name in a zone, without delegation); * note that we do not test that the name does not contain illegal characters, we only - * test for delegation. Note that service records (i.e. _foo._srv) are canonical names + * test for delegation. Note that service records (like _foo._srv) are canonical names * even though they consist of multiple labels. * * Examples: diff --git a/src/gns/plugin_gnsrecord_gns.c b/src/gns/plugin_gnsrecord_gns.c index a2ad0b905..391144925 100644 --- a/src/gns/plugin_gnsrecord_gns.c +++ b/src/gns/plugin_gnsrecord_gns.c @@ -327,7 +327,7 @@ static struct /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param cls closure, unused * @param gns_typename name to convert @@ -347,7 +347,7 @@ gns_typename_to_number (void *cls, const char *gns_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/gnsrecord/gnsrecord.c b/src/gnsrecord/gnsrecord.c index 31749a629..e9994a868 100644 --- a/src/gnsrecord/gnsrecord.c +++ b/src/gnsrecord/gnsrecord.c @@ -208,7 +208,7 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type, /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g "AAAA") to the corresponding number. * * @param dns_typename name to convert * @return corresponding number, UINT32_MAX on error @@ -235,7 +235,7 @@ GNUNET_GNSRECORD_typename_to_number (const char *dns_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param type number of a type to convert * @return corresponding typestring, NULL on error diff --git a/src/gnsrecord/plugin_gnsrecord_dns.c b/src/gnsrecord/plugin_gnsrecord_dns.c index bde9944e2..123c59905 100644 --- a/src/gnsrecord/plugin_gnsrecord_dns.c +++ b/src/gnsrecord/plugin_gnsrecord_dns.c @@ -735,7 +735,7 @@ static struct /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param cls closure, unused * @param dns_typename name to convert @@ -755,7 +755,7 @@ dns_typename_to_number (void *cls, const char *dns_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/hostlist/gnunet-daemon-hostlist_server.c b/src/hostlist/gnunet-daemon-hostlist_server.c index b6c0495c0..fb80f6331 100644 --- a/src/hostlist/gnunet-daemon-hostlist_server.c +++ b/src/hostlist/gnunet-daemon-hostlist_server.c @@ -320,7 +320,7 @@ accept_policy_callback (void *cls, * @param url the requested url * @param method the HTTP method used (#MHD_HTTP_METHOD_GET, * #MHD_HTTP_METHOD_PUT, etc.) - * @param version the HTTP version string (i.e. + * @param version the HTTP version string (e.g. * #MHD_HTTP_VERSION_1_1) * @param upload_data the data being uploaded (excluding HEADERS, * for a POST that fits into memory and that is encoded @@ -335,7 +335,7 @@ accept_policy_callback (void *cls, * @param con_cls pointer that the callback can set to some * address and that will be preserved by MHD for future * calls for this request; since the access handler may - * be called many times (i.e., for a PUT/POST operation + * be called many times (e.g. for a PUT/POST operation * with plenty of upload data) this allows the application * to easily associate some request-specific state. * If necessary, this state can be cleaned up in the diff --git a/src/identity/gnunet-identity.c b/src/identity/gnunet-identity.c index a01cd1ed7..d8dc936d3 100644 --- a/src/identity/gnunet-identity.c +++ b/src/identity/gnunet-identity.c @@ -268,13 +268,12 @@ set_done (void *cls, const char *emsg) * with 'NULL' for 'ego'. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', - * this function is only called ONCE, and 'NULL' being passed in - * 'ego' does indicate an error (i.e. name is taken or no default - * value is known). If 'ego' is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of 'GNUNET_IDENTITY_connect' (if - * that one was not NULL). + * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this + * function is only called ONCE, and 'NULL' being passed in 'ego' does + * indicate an error (for example because name is taken or no default value is + * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * 'GNUNET_IDENTITY_connect' (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) ego but the NEW identifier. diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 92572c72b..68ba8e6b2 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h @@ -94,7 +94,7 @@ struct GNUNET_ATS_Properties /** * Distance on network layer (required for distance-vector routing) - * in hops. Zero for direct connections (i.e. plain TCP/UDP). + * in hops. Zero for direct connections (e.g. plain TCP/UDP). */ unsigned int distance; @@ -136,7 +136,7 @@ struct GNUNET_ATS_PropertiesNBO /** * Distance on network layer (required for distance-vector routing) - * in hops. Zero for direct connections (i.e. plain TCP/UDP). + * in hops. Zero for direct connections (e.g. plain TCP/UDP). */ uint32_t distance GNUNET_PACKED; @@ -308,7 +308,7 @@ struct GNUNET_ATS_AddressRecord; * * @param sh handle * @param address the address - * @param session session handle (if available, i.e. for incoming connections) + * @param session session handle (if available, e.g for incoming connections) * @param prop performance data for the address * @return handle to the address representation inside ATS, NULL * on error (i.e. ATS knows this exact address already, or diff --git a/src/include/gnunet_ats_transport_service.h b/src/include/gnunet_ats_transport_service.h index b5848a36a..fd821baef 100644 --- a/src/include/gnunet_ats_transport_service.h +++ b/src/include/gnunet_ats_transport_service.h @@ -85,7 +85,7 @@ struct GNUNET_ATS_Properties /** * Distance on network layer (required for distance-vector routing) - * in hops. Zero for direct connections (i.e. plain TCP/UDP). + * in hops. Zero for direct connections (e.g. plain TCP/UDP). */ uint32_t distance; diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index aaa1f4a74..2ecd38b04 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h @@ -56,7 +56,7 @@ extern "C" * #GNUNET_NO if the service is (definitively) down, * #GNUNET_SYSERR if the configuration does not give us * the necessary information about the service, or if - * we could not check (i.e. socket() failed) + * we could not check (e.g. socket() failed) */ int GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 0d81abfd3..c8930746d 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h @@ -161,7 +161,7 @@ enum EXTRACTOR_MetaFormat * * @param cls closure (user-defined) * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data @@ -484,7 +484,7 @@ GNUNET_CONTAINER_meta_data_test_equal ( * * @param md metadata to extend * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data @@ -693,7 +693,7 @@ GNUNET_CONTAINER_meta_data_get_serialized_size ( * * @param input serialized meta-data. * @param size number of bytes available - * @return MD on success, NULL on error (i.e. + * @return MD on success, NULL on error (e.g. * bad format) */ struct GNUNET_CONTAINER_MetaData * @@ -2441,7 +2441,7 @@ GNUNET_CONTAINER_multihashmap32_iterator_destroy ( * Insertion sort of @a element into DLL from @a head to @a tail * sorted by @a comparator. * - * @param TYPE element type of the elements, i.e. `struct ListElement` + * @param TYPE element type of the elements, e.g. `struct ListElement` * @param comparator function like memcmp() to compare elements; takes * three arguments, the @a comparator_cls and two elements, * returns an `int` (-1, 0 or 1) diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h index 2a552e212..43cdfdfac 100644 --- a/src/include/gnunet_crypto_lib.h +++ b/src/include/gnunet_crypto_lib.h @@ -945,7 +945,7 @@ GNUNET_CRYPTO_hash_get_bit_rtl (const struct GNUNET_HashCode *code, /** * @ingroup hash * Determine how many low order bits match in two - * `struct GNUNET_HashCodes`. i.e. - 010011 and 011111 share + * `struct GNUNET_HashCodes`. e.g. - 010011 and 011111 share * the first two lowest order bits, and therefore the * return value is two (NOT XOR distance, nor how many * bits match absolutely!). @@ -2048,7 +2048,7 @@ struct GNUNET_CRYPTO_RsaSignature; /** * Create a new private key. Caller must free return value. * - * @param len length of the key in bits (i.e. 2048) + * @param len length of the key in bits (e.g. 2048) * @return fresh private key */ struct GNUNET_CRYPTO_RsaPrivateKey * diff --git a/src/include/gnunet_curl_lib.h b/src/include/gnunet_curl_lib.h index f291d6b14..f51e4b503 100644 --- a/src/include/gnunet_curl_lib.h +++ b/src/include/gnunet_curl_lib.h @@ -68,7 +68,7 @@ struct GNUNET_CURL_DownloadBuffer /** * Error code (based on libc errno) if we failed to download - * (i.e. response too large). + * (e.g. response too large). */ int eno; }; diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index ea3ea92fa..95d30ae6f 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h @@ -178,7 +178,7 @@ GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, * has not yet been sent to the service, cancelling the PUT will stop * this from happening (but there is no way for the user of this API * to tell if that is the case). The only use for this API is to - * prevent a later call to 'cont' from #GNUNET_DHT_put (i.e. because + * prevent a later call to 'cont' from #GNUNET_DHT_put (e.g. because * the system is shutting down). * * @param ph put operation to cancel ('cont' will no longer be called) diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index b37827ccc..731be4159 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h @@ -83,7 +83,7 @@ struct GNUNET_GETOPT_CommandLineProcessorContext * * @param ctx context for all options * @param scls specific closure (for this processor) - * @param option long name of the option (i.e. "config" for --config) + * @param option long name of the option (e.g. "config" for --config) * @param value argument, NULL if none was given * @return #GNUNET_OK to continue processing other options, #GNUNET_SYSERR to abort */ diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index aff56146e..61cbac2ca 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h @@ -308,7 +308,7 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type, const char *s, void **data, /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param dns_typename name to convert * @return corresponding number, UINT32_MAX on error @@ -318,7 +318,7 @@ GNUNET_GNSRECORD_typename_to_number (const char *dns_typename); /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param type number of a type to convert * @return corresponding typestring, NULL on error diff --git a/src/include/gnunet_gnsrecord_plugin.h b/src/include/gnunet_gnsrecord_plugin.h index 1435bc4b3..aec22c3af 100644 --- a/src/include/gnunet_gnsrecord_plugin.h +++ b/src/include/gnunet_gnsrecord_plugin.h @@ -81,7 +81,7 @@ typedef int /** - * Function called to convert a type name (i.e. "AAAA") to the + * Function called to convert a type name (e.g. "AAAA") to the * corresponding number. * * @param cls closure @@ -94,8 +94,8 @@ typedef uint32_t /** - * Function called to convert a type number (i.e. 1) to the - * corresponding type string (i.e. "A") + * Function called to convert a type number to the + * corresponding type string (e.g. 1 to "A") * * @param cls closure * @param type number of a type to convert diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index 2974568db..c123983e2 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h @@ -210,13 +210,12 @@ GNUNET_IDENTITY_ego_get_public_key (struct GNUNET_IDENTITY_Ego *ego, * with 'NULL' for @a ego. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, - * this function is only called ONCE, and 'NULL' being passed in - * @a ego does indicate an error (i.e. name is taken or no default - * value is known). If @a ego is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of #GNUNET_IDENTITY_connect (if - * that one was not NULL). + * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this + * function is only called ONCE, and 'NULL' being passed in @a ego does + * indicate an error (for example because name is taken or no default value is + * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * #GNUNET_IDENTITY_connect (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) @a ego but the NEW @a name. @@ -768,7 +767,7 @@ struct GNUNET_IDENTITY_EgoSuffixLookup; /** * Obtain the ego with the maximum suffix match between the - * ego's name and the given domain name @a suffix. I.e., given + * ego's name and the given domain name @a suffix. For example, given * a @a suffix "a.b.c" and egos with names "d.a.b.c", "b.c" and "c", * we return the ego for "b.c". * diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index 710664fe7..37bba8c1b 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h @@ -227,23 +227,23 @@ enum GNUNET_MQ_Error enum GNUNET_MQ_PriorityPreferences { /** - * Lowest priority, i.e. background traffic (i.e. NSE, FS). + * Lowest priority, i.e. background traffic (e.g. NSE, FS). * This is the default! */ GNUNET_MQ_PRIO_BACKGROUND = 0, /** - * Best-effort traffic (i.e. CADET relay, DHT) + * Best-effort traffic (e.g. CADET relay, DHT) */ GNUNET_MQ_PRIO_BEST_EFFORT = 1, /** - * Urgent traffic (local peer, i.e. Conversation). + * Urgent traffic (local peer, e.g. Conversation). */ GNUNET_MQ_PRIO_URGENT = 2, /** - * Highest priority, control traffic (i.e. CORE/CADET KX). + * Highest priority, control traffic (e.g. CORE/CADET KX). */ GNUNET_MQ_PRIO_CRITICAL_CONTROL = 3, diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index e40dacde7..97ab64add 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h @@ -561,7 +561,7 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); /** * Test if the given @a port is available. * - * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) + * @param ipproto transport protocol to test (e.g. IPPROTO_TCP) * @param port port number to test * @return #GNUNET_OK if the port is available, #GNUNET_NO if not */ diff --git a/src/include/gnunet_reclaim_plugin.h b/src/include/gnunet_reclaim_plugin.h index 2ba8fc8a0..11d5d76f7 100644 --- a/src/include/gnunet_reclaim_plugin.h +++ b/src/include/gnunet_reclaim_plugin.h @@ -92,8 +92,8 @@ typedef uint32_t (*GNUNET_RECLAIM_AttributeTypenameToNumberFunction) ( /** - * Function called to convert a type number (i.e. 1) to the - * corresponding type string + * Function called to convert a type number to the + * corresponding type string (e.g. 1 to "A") * * @param cls closure * @param type number of a type to convert @@ -154,8 +154,8 @@ typedef uint32_t (*GNUNET_RECLAIM_CredentialTypenameToNumberFunction) ( /** - * Function called to convert a type number (i.e. 1) to the - * corresponding type string + * Function called to convert a type number to the + * corresponding type string (e.g. 1 to "A") * * @param cls closure * @param type number of a type to convert @@ -253,8 +253,8 @@ typedef uint32_t (*GNUNET_RECLAIM_PresentationTypenameToNumberFunction) ( /** - * Function called to convert a type number (i.e. 1) to the - * corresponding type string + * Function called to convert a type number to the + * corresponding type string (e.g. 1 to "A") * * @param cls closure * @param type number of a type to convert diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index cc655d0b0..955a3afca 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h @@ -59,7 +59,7 @@ extern "C" /** * Convert a given fancy human-readable size to bytes. * - * @param fancy_size human readable string (i.e. 1 MB) + * @param fancy_size human readable string (e.g. 1 MB) * @param size set to the size in bytes * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -72,7 +72,7 @@ GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size, * Convert a given fancy human-readable time to our internal * representation. * - * @param fancy_time human readable string (i.e. 1 minute) + * @param fancy_time human readable string (e.g. 1 minute) * @param rtime set to the relative time * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -87,7 +87,7 @@ GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time, * representation. The human-readable time is expected to be * in local time, whereas the returned value will be in UTC. * - * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) + * @param fancy_time human readable string (e.g. %Y-%m-%d %H:%M:%S) * @param atime set to the absolute time * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -548,7 +548,7 @@ GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, * `struct sockaddr`. * * @param addr the address - * @param[out] af set to the parsed address family (i.e. AF_INET) + * @param[out] af set to the parsed address family (e.g. AF_INET) * @param[out] sa set to the parsed address * @return 0 on error, otherwise number of bytes in @a sa */ diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index acdfb2034..acb444de4 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h @@ -485,7 +485,7 @@ GNUNET_TESTBED_controller_stop (struct GNUNET_TESTBED_ControllerProc *cproc); * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") * @param cc controller callback to invoke on events * @param cc_cls closure for cc * @return handle to the controller @@ -1415,7 +1415,7 @@ typedef void * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") * @param cc controller callback to invoke on events; This callback is called * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't * set in the event_mask as this is the only way get access to the @@ -1463,7 +1463,7 @@ GNUNET_TESTBED_run (const char *host_filename, * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") * @param cc controller callback to invoke on events; This callback is called * for all peer start events even if #GNUNET_TESTBED_ET_PEER_START isn't * set in the event_mask as this is the only way get access to the diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h index 38c372f23..b9e87fcbe 100644 --- a/src/include/gnunet_time_lib.h +++ b/src/include/gnunet_time_lib.h @@ -558,7 +558,7 @@ GNUNET_TIME_get_offset (void); /** - * Return the current year (i.e. '2011'). + * Return the current year (e.g. '2011'). */ unsigned int GNUNET_TIME_get_current_year (void); diff --git a/src/include/gnunet_transport_communication_service.h b/src/include/gnunet_transport_communication_service.h index af2e36b4d..81a382fb2 100644 --- a/src/include/gnunet_transport_communication_service.h +++ b/src/include/gnunet_transport_communication_service.h @@ -94,17 +94,17 @@ struct GNUNET_TRANSPORT_CommunicatorHandle; enum GNUNET_TRANSPORT_CommunicatorCharacteristics { /** - * Characteristics are unknown (i.e. DV). + * Characteristics are unknown (e.g. DV). */ GNUNET_TRANSPORT_CC_UNKNOWN = 0, /** - * Transmission is reliabile (with ACKs), i.e. TCP/HTTP/HTTPS. + * Transmission is reliabile (with ACKs), e.g. TCP/HTTP/HTTPS. */ GNUNET_TRANSPORT_CC_RELIABLE = 1, /** - * Transmission is unreliable (i.e. UDP) + * Transmission is unreliable (e.g. UDP) */ GNUNET_TRANSPORT_CC_UNRELIABLE = 2 }; diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h index 01b10f75c..3e6d1edc6 100644 --- a/src/include/gnunet_transport_plugin.h +++ b/src/include/gnunet_transport_plugin.h @@ -49,7 +49,7 @@ * connections to a given peer. Typically used by stateful plugins to * allow the service to refer to specific streams instead of a more * general notion of "some connection" to the given peer. This is - * useful since sometimes (i.e. for inbound TCP connections) a + * useful since sometimes (e.g. for inbound TCP connections) a * connection may not have an address that can be used for meaningful * distinction between sessions to the same peer. * diff --git a/src/include/gnunet_tun_lib.h b/src/include/gnunet_tun_lib.h index 0af9a1d3e..61880cea1 100644 --- a/src/include/gnunet_tun_lib.h +++ b/src/include/gnunet_tun_lib.h @@ -746,7 +746,7 @@ GNUNET_NETWORK_STRUCT_END * Initialize an IPv4 header. * * @param ip header to initialize - * @param protocol protocol to use (i.e. IPPROTO_UDP) + * @param protocol protocol to use (e.g. IPPROTO_UDP) * @param payload_length number of bytes of payload that follow (excluding IPv4 * header) * @param src source IP address to use @@ -764,7 +764,7 @@ GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip, * Initialize an IPv6 header. * * @param ip header to initialize - * @param protocol protocol to use (i.e. IPPROTO_UDP) + * @param protocol protocol to use (e.g. IPPROTO_UDP) * @param payload_length number of bytes of payload that follow (excluding IPv4 * header) * @param src source IP address to use diff --git a/src/namestore/gnunet-namestore-fcfsd.c b/src/namestore/gnunet-namestore-fcfsd.c index 22d108067..6d794746e 100644 --- a/src/namestore/gnunet-namestore-fcfsd.c +++ b/src/namestore/gnunet-namestore-fcfsd.c @@ -751,7 +751,7 @@ lookup_it_finished (void *cls) * @param connection MHD connection handle * @param url the requested url * @param method the HTTP method used ("GET", "PUT", etc.) - * @param version the HTTP version string (i.e. "HTTP/1.1") + * @param version the HTTP version string ("HTTP/1.1" for version 1.1, etc.) * @param upload_data the data being uploaded (excluding HEADERS, * for a POST that fits into memory and that is encoded * with a supported encoding, the POST data will NOT be @@ -1057,13 +1057,12 @@ do_shutdown (void *cls) /** * Method called to inform about the egos of this peer. * - * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, - * this function is only called ONCE, and 'NULL' being passed in - * @a ego does indicate an error (i.e. name is taken or no default - * value is known). If @a ego is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of #GNUNET_IDENTITY_connect (if - * that one was not NULL). + * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this + * function is only called ONCE, and 'NULL' being passed in @a ego does + * indicate an error (for example because name is taken or no default value is + * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * #GNUNET_IDENTITY_connect (if that one was not NULL). * * @param cls closure, NULL * @param ego ego handle diff --git a/src/namestore/gnunet-zoneimport.c b/src/namestore/gnunet-zoneimport.c index ce62b52d5..68b43a016 100644 --- a/src/namestore/gnunet-zoneimport.c +++ b/src/namestore/gnunet-zoneimport.c @@ -1713,13 +1713,12 @@ process_stdin (void *cls) * with 'NULL' for @a ego. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, - * this function is only called ONCE, and 'NULL' being passed in - * @a ego does indicate an error (i.e. name is taken or no default - * value is known). If @a ego is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of #GNUNET_IDENTITY_connect (if - * that one was not NULL). + * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this + * function is only called ONCE, and 'NULL' being passed in @a ego does + * indicate an error (for example because name is taken or no default value is + * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * #GNUNET_IDENTITY_connect (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) @a ego but the NEW @a name. diff --git a/src/peerinfo-tool/gnunet-peerinfo_plugins.c b/src/peerinfo-tool/gnunet-peerinfo_plugins.c index 901ded014..e196ec58a 100644 --- a/src/peerinfo-tool/gnunet-peerinfo_plugins.c +++ b/src/peerinfo-tool/gnunet-peerinfo_plugins.c @@ -50,12 +50,12 @@ struct TransportPlugin struct GNUNET_TRANSPORT_PluginFunctions *api; /** - * Short name for the plugin (i.e. "tcp"). + * Short name for the plugin (e.g. "tcp"). */ char *short_name; /** - * Name of the library (i.e. "gnunet_plugin_transport_tcp"). + * Name of the library (e.g. "gnunet_plugin_transport_tcp"). */ char *lib_name; diff --git a/src/pt/test_gns_vpn.c b/src/pt/test_gns_vpn.c index 7b4abaec2..e20d835f8 100644 --- a/src/pt/test_gns_vpn.c +++ b/src/pt/test_gns_vpn.c @@ -530,13 +530,12 @@ fork_and_exec (const char *file, * with 'NULL' for @a ego. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, - * this function is only called ONCE, and 'NULL' being passed in - * @a ego does indicate an error (i.e. name is taken or no default - * value is known). If @a ego is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of #GNUNET_IDENTITY_connect (if - * that one was not NULL). + * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get, this + * function is only called ONCE, and 'NULL' being passed in @a ego does + * indicate an error (for example because name is taken or no default value is + * known). If @a ego is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * #GNUNET_IDENTITY_connect (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) @a ego but the NEW @a name. diff --git a/src/reclaim/plugin_gnsrecord_reclaim.c b/src/reclaim/plugin_gnsrecord_reclaim.c index 9e4f0a5c4..ce6fe483d 100644 --- a/src/reclaim/plugin_gnsrecord_reclaim.c +++ b/src/reclaim/plugin_gnsrecord_reclaim.c @@ -118,7 +118,7 @@ static struct /** - * Convert a type name (i.e. "AAAA") to the corresponding number. + * Convert a type name (e.g. "AAAA") to the corresponding number. * * @param cls closure, unused * @param dns_typename name to convert @@ -138,7 +138,7 @@ typename_to_number (void *cls, const char *dns_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string (i.e. "A") + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/reclaim/plugin_reclaim_attribute_basic.c b/src/reclaim/plugin_reclaim_attribute_basic.c index c87922886..66f59998a 100644 --- a/src/reclaim/plugin_reclaim_attribute_basic.c +++ b/src/reclaim/plugin_reclaim_attribute_basic.c @@ -124,7 +124,7 @@ basic_typename_to_number (void *cls, const char *basic_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/reclaim/plugin_reclaim_credential_jwt.c b/src/reclaim/plugin_reclaim_credential_jwt.c index e5dc90363..fb01903aa 100644 --- a/src/reclaim/plugin_reclaim_credential_jwt.c +++ b/src/reclaim/plugin_reclaim_credential_jwt.c @@ -122,7 +122,7 @@ jwt_typename_to_number (void *cls, const char *jwt_typename) /** - * Convert a type number (i.e. 1) to the corresponding type string + * Convert a type number to the corresponding type string (e.g. 1 to "A") * * @param cls closure, unused * @param type number of a type to convert diff --git a/src/reclaim/plugin_rest_openid_connect.c b/src/reclaim/plugin_rest_openid_connect.c index c6259d745..fef79fb10 100644 --- a/src/reclaim/plugin_rest_openid_connect.c +++ b/src/reclaim/plugin_rest_openid_connect.c @@ -2478,13 +2478,12 @@ userinfo_endpoint (struct GNUNET_REST_RequestHandle *con_handle, * with 'NULL' for 'ego'. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', - * this function is only called ONCE, and 'NULL' being passed in - * 'ego' does indicate an error (i.e. name is taken or no default - * value is known). If 'ego' is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of 'GNUNET_IDENTITY_connect' (if - * that one was not NULL). + * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this + * function is only called ONCE, and 'NULL' being passed in 'ego' does + * indicate an error (for example because name is taken or no default value is + * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * 'GNUNET_IDENTITY_connect' (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) ego but the NEW identifier. diff --git a/src/reclaim/plugin_rest_reclaim.c b/src/reclaim/plugin_rest_reclaim.c index 39d24ea61..1d1231cbd 100644 --- a/src/reclaim/plugin_rest_reclaim.c +++ b/src/reclaim/plugin_rest_reclaim.c @@ -1332,13 +1332,12 @@ options_cont (struct GNUNET_REST_RequestHandle *con_handle, * with 'NULL' for 'ego'. That does NOT mean that the callback won't * be invoked in the future or that there was an error. * - * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', - * this function is only called ONCE, and 'NULL' being passed in - * 'ego' does indicate an error (i.e. name is taken or no default - * value is known). If 'ego' is non-NULL and if '*ctx' - * is set in those callbacks, the value WILL be passed to a subsequent - * call to the identity callback of 'GNUNET_IDENTITY_connect' (if - * that one was not NULL). + * When used with 'GNUNET_IDENTITY_create' or 'GNUNET_IDENTITY_get', this + * function is only called ONCE, and 'NULL' being passed in 'ego' does + * indicate an error (for example because name is taken or no default value is + * known). If 'ego' is non-NULL and if '*ctx' is set in those callbacks, the + * value WILL be passed to a subsequent call to the identity callback of + * 'GNUNET_IDENTITY_connect' (if that one was not NULL). * * When an identity is renamed, this function is called with the * (known) ego but the NEW identifier. diff --git a/src/rest/gnunet-rest-server.c b/src/rest/gnunet-rest-server.c index ecb3e2ae5..63847587b 100644 --- a/src/rest/gnunet-rest-server.c +++ b/src/rest/gnunet-rest-server.c @@ -436,7 +436,7 @@ post_data_iter (void *cls, * @param con MHD connection handle * @param url the url in the request * @param meth the HTTP method used ("GET", "PUT", etc.) - * @param ver the HTTP version string (i.e. "HTTP/1.1") + * @param ver the HTTP version string ("HTTP/1.1" for version 1.1, etc.) * @param upload_data the data being uploaded (excluding HEADERS, * for a POST that fits into memory and that is encoded * with a supported encoding, the POST data will NOT be diff --git a/src/testbed/testbed_api.c b/src/testbed/testbed_api.c index f291892c6..386850b89 100644 --- a/src/testbed/testbed_api.c +++ b/src/testbed/testbed_api.c @@ -1546,7 +1546,7 @@ mq_error_handler (void *cls, enum GNUNET_MQ_Error error) * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) | ...") * @param cc controller callback to invoke on events * @param cc_cls closure for cc * @return handle to the controller diff --git a/src/testbed/testbed_api_test.c b/src/testbed/testbed_api_test.c index 30dbe455d..dd43cf2f6 100644 --- a/src/testbed/testbed_api_test.c +++ b/src/testbed/testbed_api_test.c @@ -109,7 +109,7 @@ run (void *cls, char *const *args, const char *cfgfile, * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") * @param cc controller callback to invoke on events; This callback is called * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't * set in the event_mask as this is the only way get access to the diff --git a/src/testbed/testbed_api_testbed.c b/src/testbed/testbed_api_testbed.c index 7ae30e0c6..1aa344e99 100644 --- a/src/testbed/testbed_api_testbed.c +++ b/src/testbed/testbed_api_testbed.c @@ -1237,7 +1237,7 @@ timeout_task (void *cls) * @param event_mask bit mask with set of events to call 'cc' for; * or-ed values of "1LL" shifted by the * respective 'enum GNUNET_TESTBED_EventType' - * (i.e. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") + * (e.g. "(1LL << GNUNET_TESTBED_ET_CONNECT) || ...") * @param cc controller callback to invoke on events; This callback is called * for all peer start events even if GNUNET_TESTBED_ET_PEER_START isn't * set in the event_mask as this is the only way get access to the diff --git a/src/testing/testing.c b/src/testing/testing.c index 9724fb55b..991c11a6c 100644 --- a/src/testing/testing.c +++ b/src/testing/testing.c @@ -91,7 +91,7 @@ struct SharedService struct GNUNET_TESTING_System { /** - * Prefix (i.e. "/tmp/gnunet-testing/") we prepend to each + * Prefix (e.g. "/tmp/gnunet-testing/") we prepend to each * GNUNET_HOME. */ char *tmppath; diff --git a/src/transport/gnunet-helper-transport-bluetooth.c b/src/transport/gnunet-helper-transport-bluetooth.c index 4923e6428..ef3a6292b 100644 --- a/src/transport/gnunet-helper-transport-bluetooth.c +++ b/src/transport/gnunet-helper-transport-bluetooth.c @@ -1374,7 +1374,7 @@ inquiry_devices: // skip the conditions and force a inquiry for new devices * stdin/stdout of this process. Error messages are written to stderr. * * @param argc number of arguments, must be 2 - * @param argv arguments only argument is the name of the interface (i.e. 'hci0') + * @param argv arguments only argument is the name of the interface (e.g. 'hci0') * @return 0 on success (never happens, as we don't return unless aborted), 1 on error * **** similar to gnunet-helper-transport-wlan.c **** diff --git a/src/transport/gnunet-helper-transport-wlan.c b/src/transport/gnunet-helper-transport-wlan.c index f1b190993..d90565c9c 100644 --- a/src/transport/gnunet-helper-transport-wlan.c +++ b/src/transport/gnunet-helper-transport-wlan.c @@ -1935,7 +1935,7 @@ stdin_send_hw (void *cls, const struct GNUNET_MessageHeader *hdr) * process. Error messages are written to stdout. * * @param argc number of arguments, must be 2 - * @param argv arguments only argument is the name of the interface (i.e. 'mon0') + * @param argv arguments only argument is the name of the interface (e.g. 'mon0') * @return 0 on success (never happens, as we don't return unless aborted), 1 on error */ int diff --git a/src/transport/gnunet-service-transport_plugins.c b/src/transport/gnunet-service-transport_plugins.c index d0a10cbc7..c88532806 100644 --- a/src/transport/gnunet-service-transport_plugins.c +++ b/src/transport/gnunet-service-transport_plugins.c @@ -51,12 +51,12 @@ struct TransportPlugin struct GNUNET_TRANSPORT_PluginFunctions *api; /** - * Short name for the plugin (i.e. "tcp"). + * Short name for the plugin (e.g. "tcp"). */ char *short_name; /** - * Name of the library (i.e. "gnunet_plugin_transport_tcp"). + * Name of the library (e.g. "gnunet_plugin_transport_tcp"). */ char *lib_name; diff --git a/src/util/client.c b/src/util/client.c index 746c0eb55..afd2fe900 100644 --- a/src/util/client.c +++ b/src/util/client.c @@ -892,7 +892,7 @@ connection_client_cancel_impl (struct GNUNET_MQ_Handle *mq, * #GNUNET_NO if the service is (definitively) down, * #GNUNET_SYSERR if the configuration does not give us * the necessary information about the service, or if - * we could not check (i.e. socket() failed) + * we could not check (e.g. socket() failed) */ int GNUNET_CLIENT_test (const struct GNUNET_CONFIGURATION_Handle *cfg, diff --git a/src/util/container_meta_data.c b/src/util/container_meta_data.c index efaac1136..2c477db40 100644 --- a/src/util/container_meta_data.c +++ b/src/util/container_meta_data.c @@ -337,7 +337,7 @@ GNUNET_CONTAINER_meta_data_test_equal (const struct GNUNET_CONTAINER_MetaData * * @param md metadata to extend * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data @@ -427,7 +427,7 @@ GNUNET_CONTAINER_meta_data_insert (struct GNUNET_CONTAINER_MetaData *md, * * @param cls the `struct GNUNET_CONTAINER_MetaData` to merge into * @param plugin_name name of the plugin that produced this value; - * special values can be used (i.e. '<zlib>' for zlib being + * special values can be used (e.g. '<zlib>' for zlib being * used in the main libextractor library and yielding * meta data). * @param type libextractor-type describing the meta data diff --git a/src/util/crypto_rsa.c b/src/util/crypto_rsa.c index 5e4c4d1e6..4d3de00bc 100644 --- a/src/util/crypto_rsa.c +++ b/src/util/crypto_rsa.c @@ -473,7 +473,7 @@ rsa_gcd_validate (gcry_mpi_t r, gcry_mpi_t n) /** * Create a blinding key * - * @param len length of the key in bits (i.e. 2048) + * @param len length of the key in bits (e.g. 2048) * @param bks pre-secret to use to derive the blinding key * @return the newly created blinding key, NULL if RSA key is malicious */ diff --git a/src/util/network.c b/src/util/network.c index c4adefb8f..e771a9834 100644 --- a/src/util/network.c +++ b/src/util/network.c @@ -1269,7 +1269,7 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds) /** * Test if the given @a port is available. * - * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) + * @param ipproto transport protocol to test (e.g. IPPROTO_TCP) * @param port port number to test * @return #GNUNET_OK if the port is available, #GNUNET_NO if not */ diff --git a/src/util/scheduler.c b/src/util/scheduler.c index 759312df5..d5c7b964f 100644 --- a/src/util/scheduler.c +++ b/src/util/scheduler.c @@ -193,7 +193,7 @@ struct GNUNET_SCHEDULER_Task /** * Why is the task ready? Set after task is added to ready queue. * Initially set to zero. All reasons that have already been - * satisfied (i.e. read or write ready) will be set over time. + * satisfied (e.g. read or write ready) will be set over time. */ enum GNUNET_SCHEDULER_Reason reason; diff --git a/src/util/strings.c b/src/util/strings.c index 61e04c457..b62d5f547 100644 --- a/src/util/strings.c +++ b/src/util/strings.c @@ -316,7 +316,7 @@ convert_with_table (const char *input, /** * Convert a given fancy human-readable size to bytes. * - * @param fancy_size human readable string (i.e. 1 MB) + * @param fancy_size human readable string (e.g. 1 MB) * @param size set to the size in bytes * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -348,7 +348,7 @@ GNUNET_STRINGS_fancy_size_to_bytes (const char *fancy_size, * Convert a given fancy human-readable time to our internal * representation. * - * @param fancy_time human readable string (i.e. 1 minute) + * @param fancy_time human readable string (e.g. 1 minute) * @param rtime set to the relative time * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -399,7 +399,7 @@ GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time, * representation. The human-readable time is expected to be * in local time, whereas the returned value will be in UTC. * - * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) + * @param fancy_time human readable string (e.g. %Y-%m-%d %H:%M:%S) * @param atime set to the absolute time * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ @@ -1364,7 +1364,7 @@ GNUNET_STRINGS_to_address_ip (const char *addr, * `struct sockaddr`. * * @param addr the address - * @param[out] af set to the parsed address family (i.e. AF_INET) + * @param[out] af set to the parsed address family (e.g. AF_INET) * @param[out] sa set to the parsed address * @return 0 on error, otherwise number of bytes in @a sa */ diff --git a/src/util/tun.c b/src/util/tun.c index 0e3017551..d2b675c71 100644 --- a/src/util/tun.c +++ b/src/util/tun.c @@ -37,7 +37,7 @@ * Initialize an IPv4 header. * * @param ip header to initialize - * @param protocol protocol to use (i.e. IPPROTO_UDP) + * @param protocol protocol to use (e.g. IPPROTO_UDP) * @param payload_length number of bytes of payload that follow (excluding IPv4 header) * @param src source IP address to use * @param dst destination IP address to use @@ -72,7 +72,7 @@ GNUNET_TUN_initialize_ipv4_header (struct GNUNET_TUN_IPv4Header *ip, * Initialize an IPv6 header. * * @param ip header to initialize - * @param protocol protocol to use (i.e. IPPROTO_UDP), technically "next_header" for IPv6 + * @param protocol protocol to use (e.g. IPPROTO_UDP), technically "next_header" for IPv6 * @param payload_length number of bytes of payload that follow (excluding IPv6 header) * @param src source IP address to use * @param dst destination IP address to use -- cgit v1.2.3