From f488f77e624577ba8ba0634e063ca99e26aac262 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Lindqvist?= <bjourne@gmail.com>
Date: Sun, 24 Apr 2016 21:27:00 +0200
Subject: [PATCH] tools.deploy.shaker: docs

---
 basis/tools/deploy/shaker/shaker-docs.factor | 21 ++++++++++++++++++++
 basis/tools/deploy/shaker/shaker.factor      | 11 ----------
 2 files changed, 21 insertions(+), 11 deletions(-)
 create mode 100644 basis/tools/deploy/shaker/shaker-docs.factor

diff --git a/basis/tools/deploy/shaker/shaker-docs.factor b/basis/tools/deploy/shaker/shaker-docs.factor
new file mode 100644
index 0000000000..bed9d56fa6
--- /dev/null
+++ b/basis/tools/deploy/shaker/shaker-docs.factor
@@ -0,0 +1,21 @@
+USING: help.markup help.syntax kernel tools.deploy.config ;
+IN: tools.deploy.shaker
+
+HELP: (deploy)
+{ $values
+  { "final-image" object }
+  { "vocab-manifest-out" object }
+  { "vocab" object }
+  { "config" object }
+}
+{ $description "Does the actual work of a deployment in the slave stage2 image." } ;
+
+HELP: remain-compiled
+{ $values { "old" "?" } { "new" "?" } }
+{ $description "Quotations which were formerly compiled must remain compiled." } ;
+
+HELP: strip-c-io
+{ $description "On all platforms, if " { $link deploy-io } " is 1, we strip out C streams. On Unix, if deploy-io is 3, we strip out C streams as well. On Windows, even if deploy-io is 3, C streams are still used for the console, so don't strip it there." } ;
+
+HELP: strip-default-methods
+{ $description "In a development image, each generic has its own default method. This gives better error messages for runtime type errors, but takes up space. For deployment we merge them all together." } ;
diff --git a/basis/tools/deploy/shaker/shaker.factor b/basis/tools/deploy/shaker/shaker.factor
index 7610311c90..f17550cbc8 100755
--- a/basis/tools/deploy/shaker/shaker.factor
+++ b/basis/tools/deploy/shaker/shaker.factor
@@ -280,9 +280,6 @@ IN: tools.deploy.shaker
     [ [ "No method" throw ] ( -- * ) define-temp ] with-compilation-unit ;
 
 : strip-default-methods ( -- )
-    ! In a development image, each generic has its own default method.
-    ! This gives better error messages for runtime type errors, but
-    ! takes up space. For deployment we merge them all together.
     strip-debugger? [
         "Stripping default methods" show
         [ single-generic? ] instances
@@ -428,10 +425,6 @@ IN: tools.deploy.shaker
     ] when ;
 
 : strip-c-io ( -- )
-    ! On all platforms, if deploy-io is 1, we strip out C streams.
-    ! On Unix, if deploy-io is 3, we strip out C streams as well.
-    ! On Windows, even if deploy-io is 3, C streams are still used
-    ! for the console, so don't strip it there.
     strip-io?
     native-io? os windows? not and
     or [
@@ -457,8 +450,6 @@ IN: tools.deploy.shaker
     [ compress-object? ] [ ] "objects" compress ;
 
 : remain-compiled ( old new -- old new )
-    ! Quotations which were formerly compiled must remain
-    ! compiled.
     2dup [
         2dup [ quotation-compiled? ] [ quotation-compiled? not ] bi* and
         [ nip jit-compile ] [ 2drop ] if
@@ -607,8 +598,6 @@ SYMBOL: deploy-vocab
     ] recover ; inline
 
 : (deploy) ( final-image vocab-manifest-out vocab config -- )
-    ! Does the actual work of a deployment in the slave
-    ! stage2 image
     [
         [
             strip-debugger? [