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

Update offset field name in encode API doc #5993

Merged
merged 3 commits into from
Apr 25, 2023
Merged

Update offset field name in encode API doc #5993

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2335c83
Update offset field name in encode API documentation
abhinav92003 Apr 21, 2023
c60ca9f
Fix another one.
abhinav92003 Apr 21, 2023
4e5f430
Merge branch 'master' into iX-update-encode-api-doc
abhinav92003 Apr 24, 2023
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
12 changes: 6 additions & 6 deletions core/ir/encode_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ DR_API
* Encodes \p instr into the memory at \p pc.
* Uses the x86/x64 mode stored in instr, not the mode of the current thread.
* Returns the pc after the encoded instr, or NULL if the encoding failed.
* If instr is a cti with an instr_t target, the note fields of instr and
* If instr is a cti with an instr_t target, the offset fields of instr and
* of the target must be set with the respective offsets of each instr_t!
* (instrlist_encode does this automatically, if the target is in the list).
* x86 instructions can occupy up to 17 bytes, so the caller should ensure
Expand All @@ -154,7 +154,7 @@ DR_API
*
* Uses the x86/x64 mode stored in instr, not the mode of the current thread.
* Returns the pc after the encoded instr, or NULL if the encoding failed.
* If instr is a cti with an instr_t target, the note fields of instr and
* If instr is a cti with an instr_t target, the offset fields of instr and
* of the target must be set with the respective offsets of each instr_t!
* (instrlist_encode does this automatically, if the target is in the list).
* x86 instructions can occupy up to 17 bytes, so the caller should ensure
Expand All @@ -175,8 +175,8 @@ DR_API
* Uses the x86/x64 mode stored in each instr, not the mode of the current thread.
* In order for instr_t operands to be encoded properly,
* \p has_instr_jmp_targets must be true. If \p has_instr_jmp_targets is true,
* the note field of each instr_t in ilist will be overwritten, and if any
* instr_t targets are not in \p ilist, they must have their note fields set with
* the offset field of each instr_t in ilist will be overwritten, and if any
* instr_t targets are not in \p ilist, they must have their offset fields set with
* their offsets relative to pc.
* x86 instructions can occupy up to 17 bytes each, so the caller should ensure
* the target location has enough room to avoid overflow.
Expand All @@ -200,8 +200,8 @@ DR_API
*
* In order for instr_t operands to be encoded properly,
* \p has_instr_jmp_targets must be true. If \p has_instr_jmp_targets is true,
* the note field of each instr_t in ilist will be overwritten, and if any
* instr_t targets are not in \p ilist, they must have their note fields set with
* the offset field of each instr_t in ilist will be overwritten, and if any
* instr_t targets are not in \p ilist, they must have their offset fields set with
* their offsets relative to pc.
*
* If \p max_pc is non-NULL, computes the total size required to encode the
Expand Down