From: Guilherme Maciel Ferreira Date: Sat, 19 Nov 2011 13:15:58 +0000 (-0200) Subject: Some grammatical corrections. X-Git-Tag: v1.2~8 X-Git-Url: http://developer.intra2net.com/git/?a=commitdiff_plain;h=12589451240725df25783b955d1c3b13a51e0e9b;p=pingcheck Some grammatical corrections. --- diff --git a/Readme b/Readme index 607319f..f6421bd 100644 --- a/Readme +++ b/Readme @@ -25,7 +25,7 @@ The host's address can be an IP or a DNS. --------------------------------------- There are many ways to invoke the application, the simplest is just type: ./pingcheck -which uses the configuration values from the configuration file (describled in +which uses the configuration values from the configuration file (described in the Configuration File section). @@ -39,16 +39,15 @@ section. --------------------------------------- Most parts are licensed under the GPLv2 + linking exception. -The icmp code, bost::net::dns and the "boost pinger" are -licensed under the boost license and include a note -about this in the beginning of the source code. +The ICMP code, bost::net::dns and the "boost pinger" are licensed under the +boost license and include a note about this in the beginning of the source code. 2. Configuration file ======================================= -In this section are described the configuration items, along with they -possible values and meanings. This section is organized in each major -configuration block. +In this section are described the configuration items, along with they possible +values and meanings. This section is organized in each major configuration +block. 2.1. General diff --git a/Readme.code b/Readme.code index dda9fcf..e927a3b 100644 --- a/Readme.code +++ b/Readme.code @@ -15,11 +15,11 @@ this code. --------------------------------------- This section is a guideline about the type you MUST use when declaring variables and constants. These types were chose to provide portability and -improve code reradability. +improve code readability. - Use the std::string to represent array of characters. -- Use int32_t, int16_t and int8_t (or their unsigned couter parts) - instead of +- Use int32_t, int16_t and int8_t (or their unsigned counterparts) - instead of int, short and char, respectively - when the variable or constant MUST have a specific size (e.g. like in the protocol headers). This documents that the variable has the given number of bits. This states clear the intent of the @@ -30,7 +30,7 @@ improve code reradability. use unsigned types to say a number will never be negative. - Use std::size_t for integers that represent sizes of vectors, objects or - buffers. Thus leaving the size difinition to the platform. + buffers. Thus leaving the size definition to the platform. 1.2. Coding Style @@ -88,10 +88,12 @@ decisions. 2.1. Main directories --------------------------------------- -The sources are spread over these distincts directories: -- src: contains the main application. -- test: where is located the unit tests. +The sources are spread over these distinct directories: - conf: keeps default and example configuration files. +- doc: configuration files used to build the documentation. +- lib: where lies the third party libraries maintained in this application. +- src: contains the main application source code. +- test: where is located the unit tests. 2.2. Main concept of application operation