summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAdam Hess <HParker@github.com>2023-04-05 16:11:04 -0700
committerGitHub <noreply@github.com>2023-04-05 16:11:04 -0700
commit7b27ad9ad36dbfd2ec6571b0ed15fbc4aa65d460 (patch)
tree6d331a45fd7a6fa316b020f2eba0091d8330a559 /doc
parent2f8e5c80e65a14b3a9298b6cae7ee7fc53890540 (diff)
downloadruby-7b27ad9ad36dbfd2ec6571b0ed15fbc4aa65d460.tar.gz
Add BIN as an entry in the glossary (#7667)
I initially thought this macro is referencing binary, not basic instruction name
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing/glossary.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/contributing/glossary.md b/doc/contributing/glossary.md
index 952601f813..0d27d28c96 100644
--- a/doc/contributing/glossary.md
+++ b/doc/contributing/glossary.md
@@ -4,7 +4,8 @@ Just a list of acronyms I've run across in the Ruby source code and their meanin
| Term | Definition |
| --- | -----------|
-| `bop` | Basic Operator. Relates to methods like `Integer` plus and minus which can be optimized as long as they haven't been redefined.
+| `BIN` | Basic Instruction Name. Used as a macro to reference the YARV instruction. Converts pop into YARVINSN_pop. |
+| `bop` | Basic Operator. Relates to methods like `Integer` plus and minus which can be optimized as long as they haven't been redefined. |
| `cc` | Call Cache. An inline cache structure for the call site. Stored in the `cd` |
| `cd` | Call Data. A data structure that points at the `ci` and the `cc`. `iseq` objects points at the `cd`, and access call information and call caches via this structure |
| `cfp`| Control Frame Pointer. Represents a Ruby stack frame. Calling a method pushes a new frame (cfp), returning pops a frame. Points at the `pc`, `sp`, `ep`, and the corresponding `iseq`|