Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix thread_safety_annotation filename to .hpp #6

Merged
merged 1 commit into from
Mar 28, 2019
Merged

Fix thread_safety_annotation filename to .hpp #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,10 @@ This package currently contains:
* Clang thread safety annotation macros

## Clang Thread Safety Annotation Macros
the `rcpputils/thread_safety_annotations.h` header provides macros for Clang's [Thread Safety Analysis](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) feature.
the `rcpputils/thread_safety_annotations.hpp` header provides 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"
```
To use thread safety annotation in your package (in a Clang+libcxx build), enable the `-Wthread-safety` compiler flag.

For example usage, see [the documentation of this feature](https://clang.llvm.org/docs/ThreadSafetyAnalysis.html) and the tests in `test/test_basic.cpp`
6 changes: 3 additions & 3 deletions ...ude/rcpputils/thread_safety_annotations.h → ...e/rcpputils/thread_safety_annotations.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_H_
#define RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_H_
#ifndef RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_HPP_
#define RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_HPP_

#include <mutex>

Expand Down Expand Up @@ -97,4 +97,4 @@ inline const std::mutex & operator!(const std::mutex & a)
#define RCPPUTILS_TSA_NO_THREAD_SAFETY_ANALYSIS \
RCPPUTILS_THREAD_ANNOTATION_ATTRIBUTE__(no_thread_safety_analysis)

#endif // RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_H_
#endif // RCPPUTILS__THREAD_SAFETY_ANNOTATIONS_HPP_
2 changes: 1 addition & 1 deletion test/test_basic.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#include "gtest/gtest.h"

#include "rcpputils/thread_safety_annotations.h"
#include "rcpputils/thread_safety_annotations.hpp"

/*
Macros tested
Expand Down