Merge pull request #2 from connectivecpp/develop

Merge develop to main

Author: cliffg-softwarelibre

.github/workflows/build_run_unit_test_cmake.yml

@@ -21,12 +21,10 @@ jobs:
     steps:
       - name: checkout
         uses: actions/checkout@v4
-        with:
-          path: main
       - name: create-build-dir
         run: mkdir build
       - name: configure-cmake
-        run: cd build && cmake -D WAIT_QUEUE_BUILD_TESTS:BOOL=ON -D JM_CIRCULAR_BUFFER_BUILD_TESTS:BOOL=OFF ../main/wait-queue
+        run: cd build && cmake -D WAIT_QUEUE_BUILD_TESTS:BOOL=ON -D JM_CIRCULAR_BUFFER_BUILD_TESTS:BOOL=OFF ..
       - name: build
         run: cd build && cmake --build . --config $BUILD_TYPE
       - name: run-unit-test

.github/workflows/gen_docs.yml

@@ -20,7 +20,7 @@ jobs:
       - name: run-doxygen
         uses: mattnotmitt/doxygen-action@v1.9.8
         with:
-          working-directory: docs
+          working-directory: doc
       - name: deploy-pages
         uses: peaceiris/actions-gh-pages@v4
         with:

README.md

@@ -1,51 +1,51 @@
-# `wait-queue` is a header-only C++ 20 MPMC (multiple producer / multiple consumer) thread-safe queue for passing data between threads.
+# Wait Queue, a Header-Only C++ 20 MPMC Thread-Safe Queue
 
-# Unit Test and Documentation Generation Workflow Status
+#### Unit Test and Documentation Generation Workflow Status
 
 ![GH Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/connectivecpp/wait-queue/build_run_unit_test_cmake.yml?branch=main&label=GH%20Actions%20build,%20unit%20tests%20on%20main)
 
 ![GH Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/connectivecpp/wait-queue/build_run_unit_test_cmake.yml?branch=develop&label=GH%20Actions%20build,%20unit%20tests%20on%20develop)
 
 ![GH Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/connectivecpp/wait-queue/gen_docs.yml?branch=main&label=GH%20Actions%20generate%20docs)
 
-# Overview
+## Overview
 
-`wait_queue` is a multi-reader, multi-writer FIFO queue for transferring data between threads. It is templatized on the type of data passed through the queue as well as the queue container type. Data is passed with value semantics, either by copying or by moving (as opposed to a queue that transfers data by pointer or reference). The wait queue has both wait and no-wait pop semantics. A fixed size container (e.g. a `ring_span`) can be used, eliminating any and all dynamic memory management (useful in embedded or deterministic environments). Similarly, a circular buffer that only allocates on construction can be used, which eliminates dynamic memory management when pushing or popping values on or off the queue.
+`wait_queue` is a multi-reader, multi-writer FIFO queue (often called MPMC for multiple producer / multiple consumer) for transferring data between threads. It is templatized on the type of data passed through the queue as well as the queue container type. Data is passed with value semantics, either by copying or by moving (as opposed to a queue that transfers data by pointer or reference). The wait queue has both wait and no-wait pop semantics. A fixed size container (e.g. a `ring_span`) can be used, eliminating any and all dynamic memory management (useful in embedded or deterministic environments). Similarly, a circular buffer that only allocates on construction can be used, which eliminates dynamic memory management when pushing or popping values on or off the queue.
 
 A graceful shutdown can be performed using the `request_stop` method (modeled on the C++ 20 `request_stop` from `std::stop_source`). This allows waiting reader threads to be notified for shutdown. Alternatively a `std::stop_token` can be passed in to the `wait_queue` constructor, allowing shutdown from outside of the `wait_queue` object.
 
 `wait_queue` is inspired by code from Anthony Williams' Concurrency in Action book, although heavily modified.
 
 Additional documentation can be found dkfjlkjdlkjklj
 
-# Generated Documentation
+## Generated Documentation
 
 The generated Doxygen documentation for `wait_queue` is [here](https://connectivecpp.github.io/presentations/).
 
-# Dependencies
+## Dependencies
 
 The `wait-queue` header file does not have any third-party dependencies. It uses C++ standard library headers only. The unit test code does have dependencies as noted below.
 
-# C++ Standard
+## C++ Standard
 
 `wait-queue`  uses C++ 20 features, including `std::stop_token`, `std::stop_source`, `std::condition_variable_any`, `std::scoped_lock`, and `concepts` / `requires`.
 
-# Supported Compilers
+## Supported Compilers
 
 Continuous integration workflows build and unit test on g++ (through Ubuntu), MSVC (through Windows), and clang (through macOS).
 
-# Unit Test Dependencies
+## Unit Test Dependencies
 
 The unit test code uses [Catch2](https://github.com/catchorg/Catch2). If the `WAIT_QUEUE_BUILD_TESTS` flag is provided to Cmake (see commands below) the Cmake configure / generate will download the Catch2 library as appropriate using the [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) dependency manager. If Catch2 (v3 or greater) is already installed using a different package manager (such as Conan or vcpkg), the `CPM_USE_LOCAL_PACKAGES` variable can be set which results in `find_package` being attempted. Note that v3 (or later) of Catch2 is required.
 
 The unit test uses two third-party libraries (each is a single header-only file):
 
-- Martin Moene's [`ring-span-lite`](https://github.com/martinmoene/ring-span-lite)
-- Justas Masiulis' [`circular_buffer`](https://github.com/JustasMasiulis/circular_buffer)
+- Martin Moene's [ring-span-lite](https://github.com/martinmoene/ring-span-lite)
+- Justas Masiulis' [circular_buffer](https://github.com/JustasMasiulis/circular_buffer)
 
 Specific versions and / or branches for the dependencies are in `test/CMakeLists.txt`.
 
-# Build and Run Unit Tests
+## Build and Run Unit Tests
 
 To build and run the unit test program:
 

doc/Doxyfile

@@ -864,7 +864,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../examples
+INPUT                  = ../include
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses