GUACAMOLE-1911: Merge documentation typo fixes.

src/common-ssh/common-ssh/key.h

@@ -107,7 +107,7 @@ void guac_common_ssh_key_free(guac_common_ssh_key* key);
  * single host_key, provided by the client, or a set of known_hosts entries
  * provided in the /etc/guacamole/ssh_known_hosts file.  Failure to correctly
  * load the known_hosts entries will result in a connection abort and a returned
- * error code.  A return code of zero indiciates that either no known_hosts entries
+ * error code.  A return code of zero indicates that either no known_hosts entries
  * were provided, or that the verification succeeded (match).  Negative values
  * indicate internal libssh2 error codes; positive values indicate a failure
  * during verification of the host key against the known hosts.

src/common-ssh/ssh.c

@@ -203,7 +203,7 @@ void guac_common_ssh_uninit() {
 /**
  * Callback for the keyboard-interactive authentication method. Currently
  * supports just one prompt for the password. This callback is invoked as
- * needed to fullfill a call to libssh2_userauth_keyboard_interactive().
+ * needed to fulfill a call to libssh2_userauth_keyboard_interactive().
  *
  * @param name
  *     An arbitrary name which should be printed to the terminal for the

src/common/common/cursor.h

@@ -118,7 +118,7 @@ typedef struct guac_common_cursor {
     int button_mask;
 
     /**
-     * The server timestamp representing the point in time when the mousr
+     * The server timestamp representing the point in time when the mouse
      * location was last updated.
      */
     guac_timestamp timestamp;

src/common/common/dot_cursor.h

@@ -42,7 +42,7 @@ extern const int guac_common_dot_cursor_height;
 extern const int guac_common_dot_cursor_stride;
 
 /**
- * The Cairo grapic format of the mouse cursor graphic.
+ * The Cairo graphic format of the mouse cursor graphic.
  */
 extern const cairo_format_t guac_common_dot_cursor_format;
 

src/common/common/surface.h

@@ -491,7 +491,7 @@ void guac_common_surface_flush(guac_common_surface* surface);
  *     The surface to duplicate.
  *
  * @param client
- *     The client whos users are receiving the surface.
+ *     The client whose users are receiving the surface.
  *
  * @param socket
  *     The socket over which the surface contents should be sent.

src/common/display.c

@@ -170,7 +170,7 @@ void guac_common_display_dup(
 
     pthread_mutex_lock(&display->_lock);
 
-    /* Sunchronize shared cursor */
+    /* Synchronize shared cursor */
     guac_common_cursor_dup(display->cursor, client, socket);
 
     /* Synchronize default surface */

src/common/iconv.c

@@ -140,7 +140,7 @@ int GUAC_READ_ISO8859_1(const char** input, int remaining) {
 
 /**
  * Invokes the given reader function, automatically normalizing newline
- * sequences as Unix-style newline characters ('\n').  All other charaters are
+ * sequences as Unix-style newline characters ('\n').  All other characters are
  * read verbatim.
  *
  * @param reader
@@ -256,7 +256,7 @@ void GUAC_WRITE_ISO8859_1(char** output, int remaining, int value) {
 
 /**
  * Invokes the given writer function, automatically writing newline characters
- * ('\n') as CRLF ("\r\n"). All other charaters are written verbatim.
+ * ('\n') as CRLF ("\r\n"). All other characters are written verbatim.
  *
  * @param writer
  *     The writer to use to write the given character.

src/guacd/daemon.c

@@ -85,7 +85,7 @@ static int redirect_fd(int fd, int flags) {
 
 /**
  * Turns the current process into a daemon through a series of fork() calls.
- * The standard I/O file desriptors for STDIN, STDOUT, and STDERR will be
+ * The standard I/O file descriptors for STDIN, STDOUT, and STDERR will be
  * redirected to /dev/null, and the working directory is changed to root.
  * Execution within the caller of this function will terminate before this
  * function returns, while execution within the daemonized child process will
@@ -560,7 +560,7 @@ int main(int argc, char* argv[]) {
         /*
          * FIXME: Clean up the proc map. This is not as straightforward as it
          * might seem, since the detached connection threads will attempt to
-         * remove the connection proccesses from the map when they complete,
+         * remove the connection processes from the map when they complete,
          * which will also happen upon shutdown. So there's a good chance that
          * this map cleanup will happen at the same time as the thread cleanup.
          * The map _does_ have locking mechanisms in place for ensuring thread

src/guacd/man/guacd.8.in

@@ -104,7 +104,7 @@ command. Beware that the certificate for
 be the first certificate in the file.
 .TP
 \fB-C\fR \fICERTIFICATE FILE\fR
-Enables SSL/TLS using the given cerficiate file. Future connections to
+Enables SSL/TLS using the given certificate file. Future connections to
 this instance of
 .B guacd
 will require SSL/TLS enabled in the client (the web application). If

src/guacd/man/guacd.conf.5.in

@@ -145,7 +145,7 @@ command. Beware that the certificate for
 be the first certificate in the file.
 .TP
 \fBserver_certificate\fR \fB=\fR \fICERTIFICATE FILE\fR
-Enables SSL/TLS using the given cerficiate file. Future connections to
+Enables SSL/TLS using the given certificate file. Future connections to
 .B guacd
 will require SSL/TLS enabled in the client (the web application).
 .TP

src/guacd/proc.c

@@ -232,7 +232,7 @@ static void* guacd_client_free_thread(void* data) {
 /**
  * Attempts to free the given guac_client, restricting the time taken by the
  * free handler of the guac_client to a finite number of seconds. If the free
- * handler does not complete within the time alotted, this function returns
+ * handler does not complete within the time allotted, this function returns
  * and the intended free operation is left in an undefined state.
  *
  * @param client
@@ -243,7 +243,7 @@ static void* guacd_client_free_thread(void* data) {
  *     in seconds.
  *
  * @return
- *     Zero if the guac_client was successfully freed within the time alotted,
+ *     Zero if the guac_client was successfully freed within the time allotted,
  *     non-zero otherwise.
  */
 static int guacd_timed_client_free(guac_client* client, int timeout) {

src/guacd/proc.h

@@ -35,7 +35,7 @@
 
 /**
  * The number of microseconds to wait for messages in any phase before
- * timing out and closing the conncetion with an error. This is always
+ * timing out and closing the connection with an error. This is always
  * equal to GUACD_TIMEOUT * 1000.
  */
 #define GUACD_USEC_TIMEOUT (GUACD_TIMEOUT*1000)

src/guacenc/cursor.h

@@ -27,7 +27,7 @@
 #include <guacamole/timestamp.h>
 
 /**
- * A mouse cursor, having a current location, hostspot, and associated cursor
+ * A mouse cursor, having a current location, hotspot, and associated cursor
  * image.
  */
 typedef struct guacenc_cursor {

src/guacenc/display-flatten.c

@@ -32,7 +32,7 @@
 /**
  * The Guacamole video encoder display related to the current qsort()
  * operation. As qsort() does not provide a means of passing arbitrary data to
- * the comparitor, this value must be set prior to invoking qsort() with
+ * the comparator, this value must be set prior to invoking qsort() with
  * guacenc_display_layer_comparator.
  */
 guacenc_display* __qsort_display;

src/guacenc/ffmpeg-compat.h

@@ -69,7 +69,7 @@
 #endif
 
 /**
- * Writes the specied frame as a new frame of video. If pending frames of the
+ * Writes the specified frame as a new frame of video. If pending frames of the
  * video are being flushed, the given frame may be NULL (as required by
  * avcodec_encode_video2()). If avcodec_encode_video2() does not exist, this
  * function will transparently use avcodec_encode_video().

src/guacenc/video.c

@@ -191,7 +191,7 @@ guacenc_video* guacenc_video_alloc(const char* path, const char* codec_name,
 }
 
 /**
- * Flushes the specied frame as a new frame of video, updating the internal
+ * Flushes the specified frame as a new frame of video, updating the internal
  * video timestamp by one frame's worth of time. The pts member of the given
  * frame structure will be updated with the current presentation timestamp of
  * the video. If pending frames of the video are being flushed, the given frame

src/libguac/client.c

@@ -1021,7 +1021,7 @@ int guac_client_owner_supports_required(guac_client* client) {
 }
 
 /**
- * A callback function that is invokved by guac_client_owner_notify_join() to
+ * A callback function that is invoked by guac_client_owner_notify_join() to
  * notify the owner of a connection that another user has joined the
  * connection, returning zero if the message is sent successfully, or non-zero
  * if an error occurs.
@@ -1080,7 +1080,7 @@ int guac_client_owner_notify_join(guac_client* client, guac_user* joiner) {
 }
 
 /**
- * A callback function that is invokved by guac_client_owner_notify_leave() to
+ * A callback function that is invoked by guac_client_owner_notify_leave() to
  * notify the owner of a connection that another user has left the connection,
  * returning zero if the message is sent successfully, or non-zero
  * if an error occurs.

src/libguac/encode-jpeg.c

@@ -200,7 +200,7 @@ int guac_jpeg_write(guac_socket* socket, guac_stream* stream,
     cinfo.arith_code = TRUE;
 
 #ifdef JCS_EXTENSIONS
-    /* The Turbo JPEG extentions allows us to use the Cairo surface
+    /* The Turbo JPEG extensions allows us to use the Cairo surface
      * (BGRx) as input without converting it */
     cinfo.input_components = 4;
     cinfo.in_color_space = JCS_EXT_BGRX;

src/libguac/guacamole/client-fntypes.h

@@ -59,8 +59,8 @@ typedef int guac_client_free_handler(guac_client* client);
  *     The client whose handler was invoked.
  *
  * @return
- *     Zero if the pending handler ran successfuly, or a non-zero value if an
- *     error occured.
+ *     Zero if the pending handler ran successfully, or a non-zero value if an
+ *     error occurred.
  */
 typedef int guac_client_join_pending_handler(guac_client* client);
 

src/libguac/guacamole/client.h

@@ -327,7 +327,7 @@ guac_client* guac_client_alloc();
 /**
  * Free all resources associated with the given client.
  *
- * @param client The proxy client to free all reasources of.
+ * @param client The proxy client to free all resources of.
  */
 void guac_client_free(guac_client* client);
 

src/libguac/guacamole/parser.h

@@ -143,7 +143,7 @@ void guac_parser_free(guac_parser* parser);
  * Reads a single instruction from the given guac_socket connection. This
  * may result in additional data being read from the guac_socket, stored
  * internally within a buffer for future parsing. Future calls to
- * guac_parser_read() will read from the interal buffer before reading
+ * guac_parser_read() will read from the internal buffer before reading
  * from the guac_socket. Data from the internal buffer can be removed
  * and used elsewhere through guac_parser_shift().
  *

src/libguac/guacamole/protocol.h

@@ -291,7 +291,7 @@ int guac_protocol_send_touch(guac_socket* socket, int id, int x, int y,
  *     socket directly.
  *
  * @param socket The guac_socket connection to use.
- * @param index The integer index of the stram to send the protocol
+ * @param index The integer index of the stream to send the protocol
  *              data over.
  * @param data A string containing protocol data, which must be UTF-8
  *             encoded and null-terminated.
@@ -341,7 +341,7 @@ int guac_protocol_send_set(guac_socket* socket, const guac_layer* layer,
 
 /**
  * Sends a set instruction over the given guac_socket connection. This function
- * behavies identically to guac_protocol_send_set() except that the provided
+ * behaves identically to guac_protocol_send_set() except that the provided
  * parameter value is an integer, rather than a string.
  *
  * If an error occurs sending the instruction, a non-zero value is

src/libguac/guacamole/rwlock.h

@@ -29,7 +29,7 @@
  *
  * A thread will attempt to acquire the requested lock on the first acquire
  * function call, and will release it once the number of unlock requests
- * matches the number of lock requests. Therefore, it is safe to aquire a lock
+ * matches the number of lock requests. Therefore, it is safe to acquire a lock
  * and then call a function that also acquires the same lock, provided that
  * the caller and the callee request to unlock the lock when done with it.
  *
@@ -79,7 +79,7 @@ void guac_rwlock_init(guac_rwlock* lock);
 void guac_rwlock_destroy(guac_rwlock* lock);
 
 /**
- * Aquire the write lock for the provided guac reentrant rwlock, if the key does not
+ * Acquire the write lock for the provided guac reentrant rwlock, if the key does not
  * indicate that the write lock is already acquired. If the key indicates that
  * the read lock is already acquired, the read lock will be dropped before the
  * write lock is acquired. The thread local property associated with the key
@@ -93,13 +93,13 @@ void guac_rwlock_destroy(guac_rwlock* lock);
  *     reentrantly.
  *
  * @return
- *     Zero if the lock is succesfully acquired, or a non-zero value if an
- *     error occured.
+ *     Zero if the lock is successfully acquired, or a non-zero value if an
+ *     error occurred.
  */
 int guac_rwlock_acquire_write_lock(guac_rwlock* reentrant_rwlock);
 
 /**
- * Aquire the read lock for the provided guac reentrant rwlock, if the key does not
+ * Acquire the read lock for the provided guac reentrant rwlock, if the key does not
  * indicate that the read or write lock is already acquired. The thread local
  * property associated with the key will be updated as necessary to track the
  * thread's ownership of the lock.
@@ -112,13 +112,13 @@ int guac_rwlock_acquire_write_lock(guac_rwlock* reentrant_rwlock);
  *     reentrantly.
  *
  * @return
- *     Zero if the lock is succesfully acquired, or a non-zero value if an
- *     error occured.
+ *     Zero if the lock is successfully acquired, or a non-zero value if an
+ *     error occurred.
  */
 int guac_rwlock_acquire_read_lock(guac_rwlock* reentrant_rwlock);
 
 /**
- * Release the the rwlock associated with the provided guac reentrant rwlock if this
+ * Release the rwlock associated with the provided guac reentrant rwlock if this
  * is the last level of the lock held by this thread. Otherwise, the thread
  * local property associated with the key will be updated as needed to ensure
  * that the correct number of release requests will finally release the lock.
@@ -130,8 +130,8 @@ int guac_rwlock_acquire_read_lock(guac_rwlock* reentrant_rwlock);
  *     The guac reentrant rwlock that should be released.
  *
  * @return
- *     Zero if the lock is succesfully released, or a non-zero value if an
- *     error occured.
+ *     Zero if the lock is successfully released, or a non-zero value if an
+ *     error occurred.
  */
 int guac_rwlock_release_lock(guac_rwlock* reentrant_rwlock);
 

src/libguac/guacamole/socket.h

@@ -21,7 +21,7 @@
 #define _GUAC_SOCKET_H
 
 /**
- * Defines the guac_socket object and functionss for using and manipulating it.
+ * Defines the guac_socket object and functions for using and manipulating it.
  *
  * @file socket.h
  */

src/libguac/guacamole/string.h

@@ -91,7 +91,7 @@ size_t guac_strlcpy(char* restrict dest, const char* restrict src, size_t n);
  *     buffer will remain untouched (and unterminated) in this case.
  *
  * @param src
- *     The source string to append to the the destination buffer. This string
+ *     The source string to append to the destination buffer. This string
  *     MUST be null-terminated.
  *
  * @param n

src/libguac/guacamole/user-fntypes.h

@@ -375,7 +375,7 @@ typedef int guac_user_ack_handler(guac_user* user, guac_stream* stream,
  *     The stream that is being closed.
  *
  * @return
- *     Zero if the end-of-stream condition has been sucessfully handled,
+ *     Zero if the end-of-stream condition has been successfully handled,
  *     non-zero otherwise.
  */
 typedef int guac_user_end_handler(guac_user* user, guac_stream* stream);

src/libguac/hash.c

@@ -25,7 +25,7 @@
 #include <string.h>
 
 /*
- * Arbitrary hash function whhich maps ALL 32-bit numbers onto 24-bit numbers
+ * Arbitrary hash function which maps ALL 32-bit numbers onto 24-bit numbers
  * evenly, while guaranteeing that all 24-bit numbers are mapped onto
  * themselves.
  */

src/libguac/rwlock.c

@@ -109,7 +109,7 @@ static uintptr_t get_lock_count(uintptr_t value) {
  * in the least-significant nibble, and the count in the rest.
  *
  * @param flag
- *     A flag indiciating which lock, if any, is held by the current thread.
+ *     A flag indicating which lock, if any, is held by the current thread.
  *
  * @param count
  *     The depth of the lock attempt by the current thread, i.e. the number of
@@ -139,7 +139,7 @@ static void* get_value_from_flag_and_count(
 static int would_overflow_count(uintptr_t current_count) {
 
     /**
-     * The count will overflow if it's already equal or greated to the maximum
+     * The count will overflow if it's already equal or greater to the maximum
      * possible value that can be stored in a uintptr_t excluding the first nibble.
      */
     return current_count >= (UINTPTR_MAX >> 4);

src/libguac/socket-broadcast.c

@@ -374,7 +374,7 @@ static int __guac_socket_broadcast_free_handler(guac_socket* socket) {
  *     The client who's users are being broadcast to.
  *
  * @param broadcast_handler
- *     The handler that will peform the broadcast against a subset of users
+ *     The handler that will perform the broadcast against a subset of users
  *     of the provided client.
  *
  * @return

src/libguac/socket-fd.c

@@ -325,7 +325,7 @@ static ssize_t guac_socket_fd_write_handler(guac_socket* socket,
 }
 
 /**
- * Waits for data on the underlying file desriptor of the given socket to
+ * Waits for data on the underlying file descriptor of the given socket to
  * become available such that the next read operation will not block.
  *
  * @param socket

src/libguac/socket-tee.c

@@ -210,7 +210,7 @@ static int __guac_socket_tee_free_handler(guac_socket* socket) {
 
 guac_socket* guac_socket_tee(guac_socket* primary, guac_socket* secondary) {
 
-    /* Set up socket to split outout into a file */
+    /* Set up socket to split out into a file */
     guac_socket_tee_data* data = guac_mem_alloc(sizeof(guac_socket_tee_data));
     data->primary = primary;
     data->secondary = secondary;

src/libguac/tests/id/generate.c

@@ -48,7 +48,7 @@ void test_id__unique() {
 
 /**
  * Test which verifies that guac_generate_id() produces strings are in the
- * correc UUID-based format.
+ * correct UUID-based format.
  */
 void test_id__format() {