|
1 | | -# beman.timed\_lock\_alg : Timed lock algorithms for multiple lockables |
| 1 | +# beman.timed_lock_alg : Timed lock algorithms for multiple lockables |
2 | 2 |
|
3 | 3 | <!-- |
4 | 4 | SPDX-License-Identifier: MIT |
@@ -266,41 +266,41 @@ Enable building examples. Default: ON. Values: { ON, OFF }. |
266 | 266 | Enable installing the CMake config file package. Default: ON. |
267 | 267 | Values: { ON, OFF }. |
268 | 268 |
|
269 | | -This is required so that users of `beman.timed\_lock\_alg` can use |
| 269 | +This is required so that users of `beman.timed_lock_alg` can use |
270 | 270 | `find_package(beman.timed_lock_alg)` to locate the library. |
271 | 271 |
|
272 | 272 | </details> |
273 | 273 |
|
274 | | -## Integrate beman.timed\_lock\_alg into your project |
| 274 | +## Integrate beman.timed_lock_alg into your project |
275 | 275 |
|
276 | | -To use `beman.timed\_lock\_alg` in your C++ project, |
277 | | -include an appropriate `beman.timed\_lock\_alg` header from your source code. |
| 276 | +To use `beman.timed_lock_alg` in your C++ project, |
| 277 | +include an appropriate `beman.timed_lock_alg` header from your source code. |
278 | 278 |
|
279 | 279 | ```c++ |
280 | 280 | #include <beman/timed_lock_alg/mutex.hpp> |
281 | 281 | ``` |
282 | 282 |
|
283 | 283 | > [!NOTE] |
284 | 284 | > |
285 | | -> `beman.timed\_lock\_alg` headers are to be included with the `beman/timed\_lock\_alg/` prefix. |
| 285 | +> `beman.timed_lock_alg` headers are to be included with the `beman/timed_lock_alg/` prefix. |
286 | 286 | > Altering include search paths to spell the include target another way (e.g. |
287 | 287 | > `#include <mutex.hpp>`) is unsupported. |
288 | 288 |
|
289 | | -The process for incorporating `beman.timed\_lock\_alg` into your project depends on the |
| 289 | +The process for incorporating `beman.timed_lock_alg` into your project depends on the |
290 | 290 | build system being used. Instructions for CMake are provided in following sections. |
291 | 291 |
|
292 | | -### Incorporating `beman.timed\_lock\_alg` into your project with CMake |
| 292 | +### Incorporating `beman.timed_lock_alg` into your project with CMake |
293 | 293 |
|
294 | 294 | For CMake based projects, |
295 | | -you will need to use the `beman.timed\_lock\_alg` CMake module |
296 | | -to define the `beman::timed\_lock\_alg` CMake target: |
| 295 | +you will need to use the `beman.timed_lock_alg` CMake module |
| 296 | +to define the `beman::timed_lock_alg` CMake target: |
297 | 297 |
|
298 | 298 | ```cmake |
299 | 299 | find_package(beman.timed_lock_alg REQUIRED) |
300 | 300 | ``` |
301 | 301 |
|
302 | | -You will also need to add `beman::timed\_lock\_alg` to the link libraries of |
303 | | -any libraries or executables that include `beman.timed\_lock\_alg` headers. |
| 302 | +You will also need to add `beman::timed_lock_alg` to the link libraries of |
| 303 | +any libraries or executables that include `beman.timed_lock_alg` headers. |
304 | 304 |
|
305 | 305 | ```cmake |
306 | 306 | target_link_libraries(yourlib PUBLIC beman::timed_lock_alg) |
|
0 commit comments