Explorar o código

lib/cds: Fix typos in library documentation

Florian Floimair %!s(int64=7) %!d(string=hai) anos
pai
achega
e0a20aa3dc

+ 1 - 1
src/lib/cds/doc/cds_malloc.xml

@@ -27,7 +27,7 @@
 </funcsynopsis></refsynopsisdiv>
 
 <refsect1><title>Description</title>
-<para>Allocates Memory of given size. If compiled with SER it internaly uses
+<para>Allocates Memory of given size. If compiled with SER it internally uses
 <function>shm_malloc</function>, if compiled without SER it uses 
 <function>malloc</function>.
 <!-- detailed description -->

+ 2 - 2
src/lib/cds/doc/create_message.xml

@@ -30,12 +30,12 @@
 <refsect1><title>Description</title>
 
 <para>Allocates message using <function>cds_malloc</function> and initializes
-its content so it will be freed automaticaly. Pointer to the explicitly
+its content so it will be freed automatically. Pointer to the explicitly
 allocated data is set to <parameter>data</parameter> and its length is set to
 <parameter>data_len</parameter>. Message created by <function>create_message</function> 
 should be freed using <function>message_free</function>.</para>
 
-<para>Unremoved messages created this way are freed automaticaly in
+<para>Unremoved messages created this way are freed automatically in
 <function>msg_queue_destroy</function> using <function>free_message</function>.
 </para>
 

+ 2 - 2
src/lib/cds/doc/create_message_ex.xml

@@ -30,7 +30,7 @@
 
 <para>Allocates message with data of given size
 (<parameter>data_len</parameter>) using <function>cds_malloc</function>. It
-initializes message content so it will be freed automaticaly. 
+initializes message content so it will be freed automatically. 
 Pointer to allocated data should be obtained by 
 <function>get_message_data</function>.
 </para>
@@ -38,7 +38,7 @@ Pointer to allocated data should be obtained by
 <para>Messages created by <function>create_message_ex</function> 
 should be freed using <function>message_free</function>.</para>
 
-<para>Unremoved messages created this way are freed automaticaly in
+<para>Unremoved messages created this way are freed automatically in
 <function>msg_queue_destroy</function> using <function>free_message</function>.
 </para>
 

+ 1 - 1
src/lib/cds/doc/dstring_t.xml

@@ -26,7 +26,7 @@ typedef struct _dstring_t {
 <para>This structure represents dynamic string. It allows concatenation of
 multiple strings without worry about memory allocations.</para>
 
-<para>Internaly it uses list of data buffers which are allocated 
+<para>Internally it uses list of data buffers which are allocated 
 if needed. The content of dynamic string may be copied out from internal buffers
 using simple function call (see <xref linkend="dstr_get_data"/>). Internal
 buffers are allocated in package memory (when compiled with SER)!

+ 1 - 1
src/lib/cds/doc/free_message.xml

@@ -30,7 +30,7 @@
 <para>Frees message. If data is allocated explicitly it frees it using
 <function>cds_free</function>,
 if they are allocated implicitly, it is freed together with message. Thus simple
-data strutures are deallocated automaticaly in both cases. There might be a
+data structures are deallocated automatically in both cases. There might be a
 problem with more complicated structures with internal pointers to other
 structures - for these you can set destroy function using
 <function>set_data_destroy_function</function>.

+ 1 - 1
src/lib/cds/doc/memory.xml

@@ -12,7 +12,7 @@ together with SER's memory management and must work without it too, there are
 wrapper macros for memory allocation/deallocation.</para>
 
 <para>These macros were functions and it may change in the future, but macros
-are probably better - they allow better debuging than functions. There are
+are probably better - they allow better debugging than functions. There are
 defined another macros (see <xref linkend="cds_malloc_ptr"/>, <xref
 linkend="cds_free_ptr"/>), which point and will point to allocation/deallocation
 functions, thus they may be used as function pointers.

+ 1 - 1
src/lib/cds/doc/msg_queue_destroy.xml

@@ -34,7 +34,7 @@ manipulation functions except <function>msg_queue_init</function>.
 </para>
 
 <para>All messages which stay in the queue  
-are automaticaly freed using <function>free_message</function>. 
+are automatically freed using <function>free_message</function>. 
 </para>
 
 </refsect1>

+ 1 - 1
src/lib/cds/doc/msg_queue_init_ex.xml

@@ -31,7 +31,7 @@
 <para>Initializes message queue structure. The value of
 <parameter>synchronized</parameter> may be 0 or 1. Zero means, that the message
 queue will not use mutex for internal data access (will be NOT synchronized), 1
-means that message queue will be synchronized by mutex created internaly.
+means that message queue will be synchronized by mutex created internally.
 <!-- detailed description -->
 </para>
 

+ 1 - 1
src/lib/cds/doc/pop_message.xml

@@ -28,7 +28,7 @@
 
 <refsect1><title>Description</title>
 <para>Removes first message from the queue. If the queue is empty or an error
-occurred it returns NULL value. Removed messages are NOT automaticaly freed -
+occurred it returns NULL value. Removed messages are NOT automatically freed -
 caller must use <function>free_message</function> or free it itself (see <xref
 linkend="free_message"/>)!
 </para>

+ 1 - 1
src/lib/cds/doc/push_message.xml

@@ -30,7 +30,7 @@
 <refsect1><title>Description</title>
 <para>Function pushes initialized message into message queue. This
 message may be removed from the queue using <function>pop_message</function>.
-Unremoved messages are automaticaly freed by <function>msg_queue_destroy</function> 
+Unremoved messages are automatically freed by <function>msg_queue_destroy</function> 
 (depending on message initialization, see <xref
 linkend="create_message"/>, <xref linkend="create_message_ex"/> and <xref
 linkend="init_message_ex"/>).

+ 1 - 1
src/lib/cds/doc/sstr.xml

@@ -15,7 +15,7 @@ Router due to it's usability and need of testing some parts of SER's code
 outside of <quote>SER's environment</quote>. Many of string functions were
 inspired by or directly taken from SER's code. Another reason for this structure 
 was to put string operations to one place and not leave them independently and
-often duplictly in SER's modules.</para>
+often duplicately in SER's modules.</para>
 </partintro>
 
 <include xmlns="http://www.w3.org/2001/XInclude" href="str_t.xml"/>

+ 1 - 1
src/lib/cds/doc/sstream_get_str_ex.xml

@@ -31,7 +31,7 @@
 <refsect1><title>Description</title>
 <para>Returns data buffer of requested length (<parameter>len</parameter>). If
 there is not enough data to read (less than <parameter>len</parameter> bytes), 
-the function returns error. The memory can NOT be freed becausse it is a part of
+the function returns error. The memory can NOT be freed because it is a part of
 input buffer!
 <!-- detailed description -->
 </para>