From 3e95f2a68ee8e561e049e07c1a873a13e57c7de1 Mon Sep 17 00:00:00 2001 From: Eric Cousineau Date: Thu, 28 Mar 2019 18:42:54 -0400 Subject: [PATCH] WIP Merge touch-up Signed-off-by: Eric Cousineau --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 52c09ae..207ec90 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,12 @@ See below sections for what this package currently contains. ## Clang Thread Safety Annotation Macros -The `rcpputils/thread_safety_annotations.hpp` header provides macros for Clang's [Thread Safety Analysis](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) feature. +In [`rcpputils/thread_safety_annotations.hpp`](./include/rcpputils/thread_safety_annotations.hpp), there are macros for Clang's [Thread Safety Analysis](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) feature. The macros allow you to annotate your code, but expand to nothing when using a non-clang compiler, so they are safe for cross-platform use. To use thread safety annotation in your package (in the Clang build only), enable the `-Wthread-safety` compiler flag, and include the header -``` -#include "rcpputils/thread_safety_annotations.h" -``` - For example usage, see [the documentation of this feature](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) and the tests in `test/test_basic.cpp` ## Library Discovery