From c11a83c1dd16dc727d6c10ff3bfa7b86b2a30b59 Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Mon, 24 Nov 2014 09:27:30 -0600 Subject: [PATCH] clarify materialize-user-docs docs --- pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl index 338b7846d9..10d05d1478 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl @@ -1664,10 +1664,14 @@ manuals that have been installed with @exec{raco setup}.} void?]{ Checks whether a user-specific documentation entry point already -exists with @racket[(find-user-doc-dir)], and if not, runs @exec{raco +exists in @racket[(find-user-doc-dir)], and if not, runs @exec{raco setup} in a mode that will create the entry point (to have the same content as the installation's documentation entry point.) The run of @exec{raco setup} is packaged in a thunk that is provided to @racket[on-setup], which can adjust the current output and error ports -as appropriate and check the thunk's result for success.} +as appropriate and check the thunk's result for success. + +The @racket[on-setup] argument is not called if the documentation entry +point already exists in @racket[(find-user-doc-dir)]. +}