Skip to content

Commit 6c2d505

Browse files
Merge pull request #6 from connectivecpp/develop
Merge develop to main
2 parents f979fa8 + fcce897 commit 6c2d505

5 files changed

Lines changed: 148 additions & 143 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,23 @@
1010

1111
## Overview
1212

13-
`wait_queue` is a multi-reader, multi-writer FIFO wait 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.
14-
15-
Additional documentation (which is also the main page of the generated Doxygen doc) can be found [here](doc/README.md).
13+
`wait_queue` is a multi-reader, multi-writer FIFO thread-safe wait 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.
1614

1715
## Generated Documentation
1816

1917
The generated Doxygen documentation for `wait_queue` is [here](https://connectivecpp.github.io/wait-queue/).
2018

2119
## Dependencies
2220

23-
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.
21+
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.
2422

2523
## C++ Standard
2624

27-
`wait-queue` uses C++ 20 features, including `std::stop_token`, `std::stop_source`, `std::condition_variable_any`, `std::scoped_lock`, and `concepts` / `requires`.
25+
`wait_queue` uses C++ 20 features, including `std::stop_token`, `std::stop_source`, `std::condition_variable_any`, `std::scoped_lock`, and `concepts` / `requires`.
2826

2927
## Supported Compilers
3028

31-
Continuous integration workflows build and unit test on g++ (through Ubuntu) and MSVC (through Windows). Note that clang support for C++ 20 `std::jthread` and `std::stop_token` is still incomplete as of May 2024.
29+
Continuous integration workflows build and unit test on g++ (through Ubuntu) and MSVC (through Windows). Note that clang support for C++ 20 `std::jthread` and `std::stop_token` is still experimental (and possibly incomplete) as of May 2024, so has not (yet) been tested with `wait_queue`.
3230

3331
## Unit Test Dependencies
3432

@@ -39,7 +37,7 @@ The unit test uses two third-party libraries (each is a single header-only file)
3937
- Martin Moene's [ring-span-lite](https://github.com/martinmoene/ring-span-lite)
4038
- Justas Masiulis' [circular_buffer](https://github.com/JustasMasiulis/circular_buffer)
4139

42-
Specific versions (or branches) for the dependencies are in `test/CMakeLists.txt`.
40+
Specific version (or branch) specs for the dependencies are in `test/CMakeLists.txt`.
4341

4442
## Build and Run Unit Tests
4543

‎doc/Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1061,7 +1061,7 @@ FILTER_SOURCE_PATTERNS =
10611061
# (index.html). This can be useful if you have a project on for instance GitHub
10621062
# and want to reuse the introduction page also for the doxygen output.
10631063

1064-
USE_MDFILE_AS_MAINPAGE = README.md
1064+
USE_MDFILE_AS_MAINPAGE =
10651065

10661066
#---------------------------------------------------------------------------
10671067
# Configuration options related to source browsing

‎doc/README.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)