Skip to content

Commit 31ac596

Browse files
committed
README: warn about threading
Signed-off-by: William Woodruff <[email protected]>
1 parent f2f0ee9 commit 31ac596

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
pe-parse
2-
========
1+
# pe-parse
32

43
[![CI](https://github.com/trailofbits/pe-parse/actions/workflows/ci.yml/badge.svg)](https://github.com/trailofbits/pe-parse/actions/workflows/ci.yml)
54

@@ -30,6 +29,11 @@ the PE file. This should help in constructing a sane parser that allows for dete
3029
of bogus values in the PE that would result in out of bounds accesses of the input buffer.
3130
Once data is read from the file it is sanitized and placed in C++ STL containers of internal types.
3231

32+
> [!WARNING]
33+
> pe-parse's error handling is not thread safe. If you want to perform PE
34+
> writes/parses in multiple threads, you **must** independently synchronize
35+
> your operations.
36+
3337
## Installation
3438

3539
pe-parse can be installed via [vcpkg](https://github.com/microsoft/vcpkg):

pepy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
pepy
2-
====
1+
# pepy
2+
33
pepy (pronounced p-pie) is a python binding to the pe-parse parser.
44

55
pepy supports Python versions 3.6 and above.

0 commit comments

Comments
 (0)