From: Eshel Yaron <me@eshelyaron.com>
Date: Thu, 29 Sep 2022 08:43:43 +0000 (+0300)
Subject: DOC: document the newly added sweeprolog-restart command
X-Git-Tag: v0.4.1
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b43b6019ff5402e39e16c8a2f6b6c9987660642b;p=sweep.git

DOC: document the newly added sweeprolog-restart command
---

diff --git a/README.org b/README.org
index d318ff0..d0d4f4c 100644
--- a/README.org
+++ b/README.org
@@ -125,10 +125,13 @@ which the user is free to extend with e.g.:
 To inhibit =sweeprolog= from initializing Prolog on load, set the user-option
 =sweeprolog-init-on-load= to nil.
 
-#+FINDEX: sweeprolog-cleanup
-The embedded Prolog runtime can be reset using the =sweeprolog-cleanup=
-function.  This function cleans up the Prolog state and resources,
-afterwards =sweeprolog-initialize= can be called to start Prolog anew.
+#+FINDEX: sweeprolog-restart
+The embedded Prolog runtime can be reset using the command
+=sweeprolog-restart=.  This command cleans up the the Prolog state and
+resources, and starts it anew.  When called with a prefix argument
+(=C-u M-x sweeprolog-restart=), this command prompts the user for
+additional initialization arguments to pass to the embedded Prolog
+runtime on startup.
 
 * Querying Prolog
 :PROPERTIES: