Skip to content

Commit

Permalink
README: warn about threading
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <[email protected]>
  • Loading branch information
woodruffw committed Nov 27, 2024
1 parent f2f0ee9 commit 31ac596
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
pe-parse
========
# pe-parse

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

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

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

pe-parse can be installed via [vcpkg](https://github.com/microsoft/vcpkg):
Expand Down
4 changes: 2 additions & 2 deletions pepy/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pepy
====
# pepy

pepy (pronounced p-pie) is a python binding to the pe-parse parser.

pepy supports Python versions 3.6 and above.
Expand Down

0 comments on commit 31ac596

Please sign in to comment.