Docs: bunch of smaller documentation fixes for various vocabs

[factor.git] / basis / cpu / x86 / x86-docs.factor

diff --git a/basis/cpu/x86/x86-docs.factor b/basis/cpu/x86/x86-docs.factor
index 9e904eac7a9ff6bf15a4e360d1b05cf08a397351..6f89aa8f3e1c6d6aaaaa97de5a0e010eb12b2e4f 100644 (file)
--- a/basis/cpu/x86/x86-docs.factor
+++ b/basis/cpu/x86/x86-docs.factor
@@ -1,4 +1,5 @@
-USING: help.markup help.syntax math ;
+USING: cpu.x86.assembler.operands.private help.markup help.syntax layouts
+math ;
 IN: cpu.x86
 
 HELP: stack-reg
@@ -30,6 +31,24 @@ HELP: (%inc)
   }
 } ;
 
+HELP: (%slot)
+{ $values
+  { "obj" "a register symbol" }
+  { "slot" "a register symbol" }
+  { "scale" "number of bits required to address all bytes in a " { $link cell } "." }
+  { "tag" integer }
+  { "op" indirect }
+}
+{ $description "Creates an indirect operand for addressing a slot in a container." }
+{ $examples
+  { $unchecked-example
+    "USING: cpu.x86 ;"
+    "[ RAX RBX 3 -14 (%slot) EDI MOV ] B{ } make disassemble"
+    "0000000001dd0990: 897cd80e  mov [rax+rbx*8+0xe], edi"
+  }
+} ;
+
+
 HELP: decr-stack-reg
 { $values { "n" number } }
 { $description "Emits an instruction for decrementing the stack register the given number of bytes." } ;