diff options
| -rw-r--r-- | README | 8 | ||||
| -rw-r--r-- | communication.c | 6 | ||||
| -rw-r--r-- | communication.h | 12 | ||||
| -rw-r--r-- | config.mk | 4 | ||||
| -rw-r--r-- | coopgammad.1 | 10 | ||||
| -rw-r--r-- | coopgammad.c | 2 | ||||
| -rw-r--r-- | types-ramps.h | 2 | ||||
| -rw-r--r-- | types-ring.c | 2 | ||||
| -rw-r--r-- | types-ring.h | 2 | ||||
| -rw-r--r-- | util.c | 4 | ||||
| -rw-r--r-- | util.h | 4 |
11 files changed, 29 insertions, 27 deletions
@@ -23,7 +23,7 @@ OPTIONS -f Don't fork the process to the background. If used, you can still detect when the - process has been initialised be waiting + process has been initialised by waiting for its stdout to close. -k @@ -43,7 +43,7 @@ OPTIONS The adjustment methods are supported via libgamma(7). Only methods that were enabled - when libgamma as compiled will be supported. + when libgamma was compiled will be supported. -p Add the current gamma adjustments to the @@ -59,10 +59,10 @@ OPTIONS the name of the selected site on the second line to stdout. The second line can be omitted if -s has not been used and the default site - cannot be find. + cannot be found. If used at least twice, print the pathname - of the socket for the select method and site + of the socket for the selected method and site combination to stdout. Under unusual circumstances, the path may contain LF characters, but it will always be terminated diff --git a/communication.c b/communication.c index 13d5046..75a6429 100644 --- a/communication.c +++ b/communication.c @@ -14,7 +14,7 @@ * @param conn The index of the connection * @param buf The data to send * @param n The size of `buf` - * @return Zero on success, -1 on error, 1 if disconncted + * @return Zero on success, -1 on error, 1 if disconnected * EINTR, EAGAIN, EWOULDBLOCK, and ECONNRESET count * as success (ECONNRESET cause 1 to be returned), * and are handled appropriately. @@ -110,7 +110,7 @@ proper_fail: * @param message_id The ID of the message to which this message is a response * @param desc The error description to send * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ int @@ -139,7 +139,7 @@ int * @param message_id The ID of the message to which this message is a response * @param number The value of `errno`, 0 to indicate success * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ int diff --git a/communication.h b/communication.h index b40022b..e2407b7 100644 --- a/communication.h +++ b/communication.h @@ -38,7 +38,7 @@ * * @param ... The error description to send * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ #define send_error(...) ((send_error)(conn, message_id, __VA_ARGS__)) @@ -48,7 +48,7 @@ * * @param ... The value of `errno`, 0 to indicate success * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ #define send_errno(...) ((send_errno)(conn, message_id, __VA_ARGS__)) @@ -59,7 +59,7 @@ * @param conn The index of the connection * @param buf The data to send * @param n The size of `buf` - * @return Zero on success, -1 on error, 1 if disconncted + * @return Zero on success, -1 on error, 1 if disconnected * EINTR, EAGAIN, EWOULDBLOCK, and ECONNRESET count * as success (ECONNRESET cause 1 to be returned), * and are handled appropriately. @@ -73,7 +73,7 @@ int send_message(size_t conn, char *restrict buf, size_t n); * @param message_id The ID of the message to which this message is a response * @param desc The error description to send * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ GCC_ONLY(__attribute__((__nonnull__))) @@ -86,7 +86,7 @@ int (send_error)(size_t conn, const char *restrict message_id, const char *restr * @param message_id The ID of the message to which this message is a response * @param number The value of `errno`, 0 to indicate success * @return 1: Client disconnected - * 0: Success (possibily delayed) + * 0: Success (possibly delayed) * -1: An error occurred */ GCC_ONLY(__attribute__((__nonnull__))) @@ -96,7 +96,7 @@ int (send_errno)(size_t conn, const char *restrict message_id, int number); * Continue sending the queued messages * * @param conn The index of the connection - * @return Zero on success, -1 on error, 1 if disconncted + * @return Zero on success, -1 on error, 1 if disconnected * EINTR, EAGAIN, EWOULDBLOCK, and ECONNRESET count * as success (ECONNRESET cause 1 to be returned), * and are handled appropriately. @@ -1,10 +1,12 @@ PREFIX = /usr MANPREFIX = $(PREFIX)/share/man -# For class of preserved clut +# For class of preserved CLUT PKGNAME = coopgammad COMMAND = coopgammad +# The makefile uses $(CC) and therefore expects it to be a single command name. +# If you need a specific language mode, set it via CFLAGS. CC = cc -std=c11 CPPFLAGS = -D_XOPEN_SOURCE=700 -D_DEFAULT_SOURCE -D_BSD_SOURCE -D_GNU_SOURCE -DUSE_VALGRIND diff --git a/coopgammad.1 b/coopgammad.1 index b8166b5..b20c6f6 100644 --- a/coopgammad.1 +++ b/coopgammad.1 @@ -1,7 +1,7 @@ .TH COOPGAMMAD 1 COOPGAMMAD .SH "NAME" coopgammad - Cooperative gamma server -.SH "SYNPOSIS" +.SH "SYNOPSIS" .B coopgammad .RB [ -m .IR method ] @@ -30,7 +30,7 @@ modified or removed later by another process. .B -f Don't fork the process to the background. If used, you can still detect when the -process has been initialised be waiting +process has been initialised by waiting for its stdout to close. .TP .B -k @@ -55,7 +55,7 @@ The adjustment methods are supported via .BR libgamma (7). Only methods that were enabled when .B libgamma -as compiled will be supported. +was compiled will be supported. .TP .B -p Add the current gamma adjustments to the @@ -73,10 +73,10 @@ line to stdout. The second line can be omitted if .B -s has not been used and the default site cannot -be find. +be found. If used at least twice, print the pathname -of the socket for the select method and site +of the socket for the selected method and site combination to stdout. Under unusual circumstances, the path may contain LF characters, but it will always be terminated diff --git a/coopgammad.c b/coopgammad.c index 8638679..3f4eb78 100644 --- a/coopgammad.c +++ b/coopgammad.c @@ -37,7 +37,7 @@ /** * Lists all function recognised adjustment methods, - * will call macro X with the code for the each + * will call macro X with the code for each * adjustment method as the first argument and * corresponding name as the second argument */ diff --git a/types-ramps.h b/types-ramps.h index 6e64efc..b0b1992 100644 --- a/types-ramps.h +++ b/types-ramps.h @@ -14,7 +14,7 @@ /** * Gamma ramps union for all - * lbigamma gamma ramps types + * libgamma gamma ramps types */ union gamma_ramps { /** diff --git a/types-ring.c b/types-ring.c index 6cceea1..15e52d6 100644 --- a/types-ring.c +++ b/types-ring.c @@ -173,7 +173,7 @@ ring_peek(struct ring *restrict this, size_t *restrict n) /** - * Dequeue data from a ring bubber + * Dequeue data from a ring buffer * * @param this The ring buffer * @param n The number of bytes to dequeue diff --git a/types-ring.h b/types-ring.h index c8b5f77..0a022ee 100644 --- a/types-ring.h +++ b/types-ring.h @@ -94,7 +94,7 @@ GCC_ONLY(__attribute__((__nonnull__))) void *ring_peek(struct ring *restrict this, size_t *restrict n); /** - * Dequeue data from a ring bubber + * Dequeue data from a ring buffer * * @param this The ring buffer * @param n The number of bytes to dequeue @@ -92,7 +92,7 @@ fail: * Not cancelled by `EINTR` * * @param fd The file descriptor - * @param buf The buffer which shall be written to the fail + * @param buf The buffer which shall be written to the file * @param n The size of the buffer * @return The number of written bytes, less than `n` * on error, cannot exceed `n` @@ -119,7 +119,7 @@ nwrite(int fd, const void *restrict buf, size_t n) /** - * Perform a timed suspention of the process. + * Perform a timed suspension of the process. * The process resumes when the timer expires, * or when it is interrupted. * @@ -42,7 +42,7 @@ void *nread(int fd, size_t *restrict n); * Not cancelled by `EINTR` * * @param fd The file descriptor - * @param buf The buffer which shall be written to the fail + * @param buf The buffer which shall be written to the file * @param n The size of the buffer * @return The number of written bytes, less than `n` * on error, cannot exceed `n` @@ -50,7 +50,7 @@ void *nread(int fd, size_t *restrict n); size_t nwrite(int fd, const void *restrict buf, size_t n); /** - * Perform a timed suspention of the process. + * Perform a timed suspension of the process. * The process resumes when the timer expires, * or when it is interrupted. * |