Update comment

adammccartney · adammccartney · commit 0432805ad787 · 2026-03-25T14:59:29.000+01:00
diff --git a/init/lmod/sh b/init/lmod/sh
@@ -25,7 +25,7 @@
 # - The EESSI module also listens to environment variables so that it can be silently configured by a site
 #   - EESSI_MODULE_FAMILY_NAME: use the value of the environment variable to set an Lmod family for the EESSI module
 #   - EESSI_MODULE_STICKY: make the EESSI module sticky
-#   - EESSI_MODULE_UPDATE_PS1: have the EESSI module update PS1 to give a prompt that is prepended with "{EESSI/...} " (requires exporting PS1)
+#   - EESSI_MODULE_UPDATE_PS1: set to 1 (by default), the EESSI module prepends  "{EESSI/...} " to PS1 (the shell prompt). Set to 0, PS1 remains unmodified.
 #  (- EESSI_MODULE_DEBUG_INIT: enable debug print statements when loading the EESSI module)
 #
 # Effects:

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`# - The EESSI module also listens to environment variables so that it can be silently configured by a site`
`26`	`26`	`# - EESSI_MODULE_FAMILY_NAME: use the value of the environment variable to set an Lmod family for the EESSI module`
`27`	`27`	`# - EESSI_MODULE_STICKY: make the EESSI module sticky`
`28`		`-# - EESSI_MODULE_UPDATE_PS1: have the EESSI module update PS1 to give a prompt that is prepended with "{EESSI/...} " (requires exporting PS1)`
	`28`	`+# - EESSI_MODULE_UPDATE_PS1: set to 1 (by default), the EESSI module prepends "{EESSI/...} " to PS1 (the shell prompt). Set to 0, PS1 remains unmodified.`
`29`	`29`	`# (- EESSI_MODULE_DEBUG_INIT: enable debug print statements when loading the EESSI module)`
`30`	`30`	`#`
`31`	`31`	`# Effects:`