From d074f1a9c9af3fab7998138128183ff5398dd168 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Lindqvist?= <bjourne@gmail.com>
Date: Mon, 5 May 2014 01:38:43 +0200
Subject: [PATCH] Docs: for cpu.x86.* words

---
 basis/cpu/x86/64/64-docs.factor | 11 ++++++++++
 basis/cpu/x86/x86-docs.factor   | 37 +++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 basis/cpu/x86/64/64-docs.factor
 create mode 100644 basis/cpu/x86/x86-docs.factor

diff --git a/basis/cpu/x86/64/64-docs.factor b/basis/cpu/x86/64/64-docs.factor
new file mode 100644
index 0000000000..e13bddf9b5
--- /dev/null
+++ b/basis/cpu/x86/64/64-docs.factor
@@ -0,0 +1,11 @@
+USING: help.markup help.syntax math ;
+IN: cpu.x86.64
+
+HELP: vm-reg
+{ $description
+  "Symbol of the machine register that holds the address of the virtual machine."
+} ;
+
+HELP: param-reg
+{ $values { "n" number } { "reg" "a register symbol" } }
+{ $description "Symbol of the machine register for the nth function parameter (0-based)." } ;
diff --git a/basis/cpu/x86/x86-docs.factor b/basis/cpu/x86/x86-docs.factor
new file mode 100644
index 0000000000..a2be230077
--- /dev/null
+++ b/basis/cpu/x86/x86-docs.factor
@@ -0,0 +1,37 @@
+USING: help.markup help.syntax ;
+IN: cpu.x86
+
+HELP: stack-reg
+{ $description
+  "Symbol of the machine register that holds the (cpu) stack address."
+} ;
+
+HELP: ds-reg
+{ $description
+  "Symbol of the machine register that holds the address to the data stack's location."
+} ;
+
+HELP: (%inc)
+{ $description
+  "Generates machine code for increasing or decreasing the given register a number of cell sizes bytes."
+}
+{ $examples
+  { $unchecked-example
+    "USING: cpu.x86 make prettyprint ;"
+    "[ 8 ECX (%inc) ] B{ } make disassemble"
+    "00000000615e5140: 83c140  add ecx, 0x40"
+  }
+} ;
+
+HELP: load-zone-offset
+{ $values { "nursery-ptr" "a register symbol" } }
+{ $description
+  "Generates machine code for loading the address to the nursery into the machine register."
+}
+{ $examples
+  { $unchecked-example
+    "USING: cpu.x86 make prettyprint ;"
+    "[ RCX load-zone-offset ] B{ } make disassemble"
+    "0000000001b48f80: 498d4d10  lea rcx, [r13+0x10]"
+  }
+} ;