From: Eshel Yaron <me@eshelyaron.com>
Date: Sat, 15 Oct 2022 08:10:34 +0000 (+0300)
Subject: DOC: mention new sweep Prolog flag in README.org and NEWS.org
X-Git-Tag: V8.5.18-sweep-0.6.2~1
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=af3c350764cfa63fee7ca4ea493208ca75770d27;p=sweep.git

DOC: mention new sweep Prolog flag in README.org and NEWS.org
---

diff --git a/NEWS.org b/NEWS.org
index 139ae2d..36a1195 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -11,6 +11,14 @@ SWI-Prolog in Emacs.
 For further details, please consult the manual:
 <https://eshelyaron.com/sweep.html>.
 
+* Version 0.6.2 on 2022-10-15
+
+** Added a Prolog indicating the Prolog is running under ~sweep~
+
+=sweeprolog.el= now creates a boolean Prolog flag ~sweep~ set to ~true~ when
+initiating Prolog, to allow users to customize their Prolog init file
+accordingly.
+
 * Version 0.6.0 on 2022-10-10
 
 ** Added integration with Flymake
diff --git a/README.org b/README.org
index a925fa5..9f9d9a5 100644
--- a/README.org
+++ b/README.org
@@ -150,6 +150,11 @@ which the user is free to extend with e.g.:
   (add-to-list 'sweeprolog-init-args "--stack-limit=512m")
 #+end_src
 
+#+CINDEX: sweep Prolog flag
+The default value of ~sweeprolog-init-args~ is set to load the Prolog
+helper library =sweep.pl= and to create a boolean Prolog flag ~sweep~, set
+to ~true~, which indicates to SWI-Prolog that it is running under ~sweep~.
+
 #+VINDEX: sweeprolog-init-on-load
 To inhibit =sweeprolog= from initializing Prolog on load, set the user-option
 =sweeprolog-init-on-load= to nil.