From 4ac167da6ee9bbca209ca92a4f22990d139ec015 Mon Sep 17 00:00:00 2001 From: Attila Kovacs Date: Thu, 19 Sep 2024 07:35:53 +0200 Subject: [PATCH] small header, workflow, and site update --- .github/workflows/dox.yml | 3 --- README.md | 16 +++++++++------- include/redisx.h | 9 +++++---- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/dox.yml b/.github/workflows/dox.yml index 1d2b90b..8b4db78 100644 --- a/.github/workflows/dox.yml +++ b/.github/workflows/dox.yml @@ -32,9 +32,6 @@ jobs: name: Generate API documentation runs-on: ubuntu-latest - env: - CC: gcc - XCHANGE: xchange steps: - name: install doxygen diff --git a/README.md b/README.md index a2b9b5b..f786a36 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,13 @@ A simple, light-weight C/C++ Redis client library. + - [API documentation](https://smithsonian.github.io/redisx/apidoc/html/files.html) + - [Project page](https://smithsonian.github.io/redisx) on github.io + +Author: Attila Kovacs + +Last Updated: 18 September 2024 + ## Table of Contents - [Introduction](#introduction) @@ -58,12 +65,6 @@ repository on GitHub. There are no official releases of __RedisX__ yet. An initial 1.0.0 release is expected in late 2024 or early 2025. Before then the API may undergo slight changes and tweaks. Use the repository as is at your own risk for now. -Some related links: - - - [API documentation](https://smithsonian.github.io/redisx/apidoc/html/files.html) - - [Project page](https://smithsonian.github.io/redisx) on github.io - - ----------------------------------------------------------------------------- @@ -91,7 +92,8 @@ prior to invoking `make`. The following build variables can be configured: - `CPPFLAGS`: C pre-processor flags, such as externally defined compiler constants. - - `CFLAGS`: Flags to pass onto the C compiler (default: `-Os -Wall`). Note, `-Iinclude` will be added automatically. + - `CFLAGS`: Flags to pass onto the C compiler (default: `-Os -Wall -std=c99`). Note, `-Iinclude` will be added + automatically. - `LDFLAGS`: Linker flags (default is `-lm`). Note, `-lxchange` will be added automatically. diff --git a/include/redisx.h b/include/redisx.h index 44b9e61..27b0c02 100644 --- a/include/redisx.h +++ b/include/redisx.h @@ -120,10 +120,11 @@ enum redisx_channel { * \sa redisxDestroyRESP() */ typedef struct RESP { - char type; ///< value type RESP_ARRAY, RESP_INT ... - int n; ///< Either the integer value of a RESP_INT response, or the dimension of - ///< the value field. - void *value; ///< Pointer to text (char *) content to an array of components (RESP**)... + char type; ///< RESP type RESP_ARRAY, RESP_INT ... + int n; ///< Either the integer value of a RESP_INT response, or the + ///< dimension of the value field. + void *value; ///< Pointer to text (char *) content or to an array of components + ///< (RESP**)... } RESP;