From 65a22811881169d5884b8947d30d934859e6d7ca Mon Sep 17 00:00:00 2001
From: Alexander Iljin <ajsoft@yandex.ru>
Date: Tue, 20 Sep 2016 22:51:31 +0300
Subject: [PATCH] io.launcher-docs: add notes on the hidden slot usage

---
 basis/io/launcher/launcher-docs.factor | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/basis/io/launcher/launcher-docs.factor b/basis/io/launcher/launcher-docs.factor
index f899ea8ce4..24f0879dc8 100644
--- a/basis/io/launcher/launcher-docs.factor
+++ b/basis/io/launcher/launcher-docs.factor
@@ -12,7 +12,9 @@ ARTICLE: "io.launcher.detached" "Running processes in the background"
 { $subsections run-detached } ;
 
 ARTICLE: "io.launcher.hidden" "Running hidden processes"
-"By default, child processes can create and display their own (console and other) windows. To signal to a process that it should stay hidden, set the " { $snippet "hidden" } " slot of the " { $link process } " before running it. The processes are free to ignore this signal." ;
+"By default, child processes can create and display their own (console and other) windows. To signal to a process that it should stay hidden, set the " { $slot "hidden" } " slot of the " { $link process } " before running it. The processes are free to ignore this signal."
+$nl
+"The " { $link <process-stream> } " and " { $link with-process-stream } " words set this flag. On Windows this helps to run console applications without flashing their windows in the foreground." ;
 
 ARTICLE: "io.launcher.environment" "Setting environment variables"
 "The " { $snippet "environment" } " slot of a " { $link process } " contains an association mapping environment variable names to values. The interpretation of environment variables is operating system-specific."
@@ -196,7 +198,9 @@ HELP: <process-stream>
   { "desc" "a launch descriptor" }
   { "encoding" "an encoding descriptor" }
   { "stream" "a bidirectional stream" } }
-{ $description "Launches a process and redirects its input and output via a pair of pipes which may be read and written as a stream with the given encoding." } ;
+{ $description "Launches a process and redirects its input and output via a pair of pipes which may be read and written as a stream with the given encoding." }
+{ $notes "The process is started with the " { $slot "hidden" } " slot set to " { $link t } "." }
+{ $see-also "io.launcher.hidden" } ;
 
 HELP: <process-reader>
 { $values
@@ -219,7 +223,9 @@ HELP: with-process-stream
   { "encoding" "an encoding descriptor" }
   { "quot" quotation }
 }
-{ $description "Launches a process and redirects its input and output via a pair of pipes. The quotation is called with " { $link input-stream } " and " { $link output-stream } " rebound to these pipes." } ;
+{ $description "Launches a process and redirects its input and output via a pair of pipes. The quotation is called with " { $link input-stream } " and " { $link output-stream } " rebound to these pipes." }
+{ $notes "The process is started with the " { $slot "hidden" } " slot set to " { $link t } "." }
+{ $see-also "io.launcher.hidden" } ;
 
 HELP: with-process-reader
 { $values