[GNUnet-SVN] r6649 - libmicrohttpd/doc

[gnunet]

Author: grothoff
Date: 2008-03-29 21:34:44 -0600 (Sat, 29 Mar 2008)
New Revision: 6649

Modified:
   libmicrohttpd/doc/microhttpd.texi
Log:
Karl Berry wrote:
Also, a trivial point, you use en-dashes for hyphenated phrases, such as
"thread-safe" and "key-value".  In normal English typesetting these are
just hyphens, so "thread-safe" rather than "thread--safe".


Modified: libmicrohttpd/doc/microhttpd.texi
===================================================================
--- libmicrohttpd/doc/microhttpd.texi   2008-03-29 21:03:49 UTC (rev 6648)
+++ libmicrohttpd/doc/microhttpd.texi   2008-03-30 03:34:44 UTC (rev 6649)
@@ -118,7 +118,7 @@
 @mhd{}.
 
 All functions are guaranteed to be completely reentrant and
-thread--safe.
+thread-safe.
 
 
 
@@ -196,7 +196,7 @@
 
 @item MHD_OPTION_NOTIFY_COMPLETED
 Register a function that should be called whenever a request has been
-completed (this can be used for application--specific clean up).
+completed (this can be used for application-specific clean up).
 Requests that have never been presented to the application (via
 @cfunction{MHD_AccessHandlerCallback}) will not result in
 notifications.
@@ -210,7 +210,7 @@
 
 
 @deftp {Enumeration} MHD_ValueKind
-The @code{MHD_ValueKind} specifies the source of the key--value pairs in
+The @code{MHD_ValueKind} specifies the source of the key-value pairs in
 the @http{} protocol.
 
 @table @code
@@ -366,7 +366,7 @@
 
 since the access handler may be called many times (i.e., for a
 @code{PUT}/@code{POST} operation with plenty of upload data) this allows
-the application to easily associate some request--specific state;
+the application to easily associate some request-specific state;
 
 if necessary, this state can be cleaned up in the global
 @code{MHD_RequestCompletedCallback} (which can be set with the
@@ -397,8 +397,8 @@
 
 
 @deftypefn {Function Pointer} int {*MHD_KeyValueIterator} (void *cls, enum 
MHD_ValueKind kind, const char *key, const char *value)
-Iterator over key--value pairs.  This iterator can be used to iterate
-over all of the cookies, headers, or @code{POST}--data fields of a
+Iterator over key-value pairs.  This iterator can be used to iterate
+over all of the cookies, headers, or @code{POST}-data fields of a
 request, and also to iterate over the headers that have been added to a
 response.
 
@@ -413,7 +413,7 @@
 number of bytes that has been placed into @var{buf} should be returned.
 
 Note that returning zero will cause @mhd{} to try again, either
-``immediately'' if in multi--threaded mode (in which case the callback
+``immediately'' if in multi-threaded mode (in which case the callback
 may want to do blocking operations) or in the next round if MHD_run is
 used.  Returning zero for a daemon that runs in internal
 @cfunction{select} mode is an error (since it would result in busy
@@ -425,10 +425,10 @@
 
 @item pos
 position in the datastream to access; note that if an
address@hidden object is re--used, it is possible for the same
address@hidden object is re-used, it is possible for the same
 content reader to be queried multiple times for the same data; however,
-if an @code{MHD_Response} is not re--used, @mhd{} guarantees that
address@hidden will be the sum of all non--negative return values obtained
+if an @code{MHD_Response} is not re-used, @mhd{} guarantees that
address@hidden will be the sum of all non-negative return values obtained
 from the content reader so far.
 @end table
 
@@ -444,8 +444,8 @@
 
 
 @deftypefn {Function Pointer} int {*MHD_PostDataIterator} (void *cls, enum 
MHD_ValueKind kind, const char *key, const char *filename, const char 
*content_type, const char *transfer_encoding, const char *data, size_t off, 
size_t size)
-Iterator over key--value pairs where the value maybe made available in
-increments and/or may not be zero--terminated.  Used for processing
+Iterator over key-value pairs where the value maybe made available in
+increments and/or may not be zero-terminated.  Used for processing
 @code{POST} data.
 
 @table @var
@@ -456,13 +456,13 @@
 type of the value;
 
 @item key
-zero--terminated key for the value;
+zero-terminated key for the value;
 
 @item filename
 name of the uploaded file, @null{} if not known;
 
 @item content_type
-mime--type of the data, @null{} if not known;
+mime-type of the data, @null{} if not known;
 
 @item transfer_encoding
 encoding of the data, @null{} if not known;
@@ -494,7 +494,7 @@
 
 @table @var
 @item flags
-OR--ed combination of @code{MHD_FLAG} values;
+OR-ed combination of @code{MHD_FLAG} values;
 
 @item port
 port to bind to;
@@ -514,7 +514,7 @@
 extra argument to @var{dh}.
 @end table
 
-Additional arguments are a list of options (type--value pairs,
+Additional arguments are a list of options (type-value pairs,
 terminated with @code{MHD_OPTION_END}). It is mandatory to use
 @code{MHD_OPTION_END} as last argument, even when there are no
 additional arguments.
@@ -531,7 +531,7 @@
 @deftypefun int MHD_run (struct MHD_Daemon *daemon)
 Run webserver operations (without blocking unless in client callbacks).
 This method should be called by clients in combination with
address@hidden if the client--controlled @cfunction{select}
address@hidden if the client-controlled @cfunction{select}
 method is used.
 
 Return @code{MHD_YES} on success, @code{MHD_NO} if this daemon was not
@@ -541,7 +541,7 @@
 
 @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
address@hidden ------------------------------------------------------------
address@hidden -----------------------------------------------------------
 @node microhttpd inspect
 @appendixsec Inspection
 
@@ -584,7 +584,7 @@
 
 @c ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
address@hidden ------------------------------------------------------------
address@hidden -----------------------------------------------------------
 @node microhttpd requests
 @appendixsec Handling requests
 
@@ -628,7 +628,7 @@
 
 @deftypefun int MHD_register_handler (struct MHD_Daemon *daemon, const char 
*uri_prefix, MHD_AccessHandlerCallback dh, void *dh_cls)
 Register an access handler for all @uri{}s beginning with
address@hidden, a zero--terminated @ascii{}--coded string.
address@hidden, a zero-terminated @ascii{}-coded string.
 
 Return @code{MRI_NO} if: the arguments are invalid (example: @null{}
 pointers); a handler for this exact prefix already exists; an error
@@ -668,7 +668,7 @@
 @deftypefun {const char *} MHD_lookup_connection_value (struct MHD_Connection 
*connection, enum MHD_ValueKind kind, const char *key)
 Get a particular header value.  If multiple values match the @var{kind},
 return one of them (the ``first'', whatever that means).  @var{key} must
-reference a zero--terminated @ascii{}--coded string representing the
+reference a zero-terminated @ascii{}-coded string representing the
 header to look for: it is compared against the headers using
 @cfunction{strcasecmp}, so case is ignored.  Return @null{} if no such
 item was found.
@@ -866,7 +866,7 @@
 
 @deftypefun int MHD_add_response_header (struct MHD_Response *response, const 
char *header, const char *content)
 Add a header line to the response. The strings referenced by
address@hidden and @var{content} must be zero--terminated and they are
address@hidden and @var{content} must be zero-terminated and they are
 duplicated into memory blocks embedded in @var{response}.
 
 Notice that the strings must not hold newlines, carriage returns or tab
@@ -905,7 +905,7 @@
 
 @deftypefun {const char *} MHD_get_response_header (struct MHD_Response 
*response, const char *key)
 Find and return a pointer to the value of a particular header from the
-response.  @var{key} must reference a zero--terminated string
+response.  @var{key} must reference a zero-terminated string
 representing the header to look for. The search is case sensitive.
 Return @null{} if header does not exist or @var{key} is @null{}.
 
@@ -1185,7 +1185,7 @@
 @end table
 
 Return @code{MHD_YES} on success, @code{MHD_NO} on error
-(out--of--memory, iterator aborted, parse error).
+(out-of-memory, iterator aborted, parse error).
 @end deftypefun