diff --git a/ofrak_core/CHANGELOG.md b/ofrak_core/CHANGELOG.md index ee1704b28..f0554df21 100644 --- a/ofrak_core/CHANGELOG.md +++ b/ofrak_core/CHANGELOG.md @@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed - Fix `Resource.get_attributes` docstring to match implementation ([#692](https://github.com/redballoonsecurity/ofrak/pull/692)) +- Document `CodeRegion` requirement to be descendant of `Program` for disassembly ([#696](https://github.com/redballoonsecurity/ofrak/pull/696)) - Fix GUI serialization of enum values and script creator generating invalid Python syntax for enum values - `build_image.py` uses `OFRAK_DIR` from `extra_build_args` to identify `pytest_ofrak` location for develop builds ([#657](https://github.com/redballoonsecurity/ofrak/pull/657/)) diff --git a/ofrak_core/src/ofrak/core/code_region.py b/ofrak_core/src/ofrak/core/code_region.py index d437b051a..e7aea8b27 100644 --- a/ofrak_core/src/ofrak/core/code_region.py +++ b/ofrak_core/src/ofrak/core/code_region.py @@ -9,6 +9,9 @@ class CodeRegion(MemoryRegion): """ A memory region within a [program][ofrak.core.program.Program] that contains executable code. + + Must be a descendant of a Program for disassembly, as disassembler backends use the ancestor + Program to locate their analysis context. """