DOC: Handling of <Command>_gui wrappers explained.

share/fsl/sbin/createFSLWrapper

@@ -8,6 +8,9 @@
 # executables that are installed into the FSL conda environment (for example,
 # python, pip, tcl, etc).
 #
+# This script is intended to be called by the post-link.sh script of the conda
+# recipe for each FSL project that provides executable commands.
+#
 # This script should only be invoked when FSL is being installed via the
 # fslinstaller script - it is not intended to be used when individual FSL
 # projects are explicitly installed into a custom conda environment.
@@ -16,9 +19,6 @@
 # FSL_CREATE_WRAPPER_SCRIPTS variables are set appropriately before creating
 # the FSL conda environment.
 #
-# This script is intended to be called by the post-link.sh script of the conda
-# recipe for each FSL project that provides executable commands.
-#
 # Wrapper scripts will only be created if the following conditions are met:
 #
 #  - The $FSLDIR and $PREFIX environment variables are set, and
@@ -41,6 +41,17 @@
 #    characters. Depending on where FSL is installed, it may not be possible
 #    to have a shebang line pointing to $FSLDIR/bin/python which does not
 #    exceed 127 characters.
+#
+# Wrapper scripts are created for *all* FSL commands, including FSL TCL GUI
+# commands (e.g. "fsl", "Flirt", "Flirt_gui", etc).  FSL TCL GUIs are called
+# (e.g.) "<Command>" om Linux, but "<Command>_gui" on macOS, because macOS
+# file systems are usually case-sensitive.
+#
+# To work around this, and to not accidentally create a link called <Command>
+# to <command>, the FSL package post link scripts should only specify
+# "<Command>_gui", and *not* "<Command>".  This script will create a wrapper
+# script for the appropriate variant ("<Command>_gui" on macOS, or "<Command>"
+# on Linux).
 
 # Names of all executables for which wrapper
 # scripts are to be created are passed as
@@ -67,15 +78,10 @@ fi
 for script in $targets; do
   sourceScript="${PREFIX}/bin/$script"
 
-  # FSL GUIs are called (e.g.) <Command> om Linux,
-  # but <Command>_gui on macOS, because macOS file
-  # systems are usually case-sensitive. To work
-  # around this (and to not accidentally create a
-  # link called <Command> to <command>), the FSL
-  # package post link scripts only specify
-  # <Command>_gui. Here, we remove the _gui suffix
-  # if no source file exists (in which we are
-  # likely running on Linux)
+  # Wrapper script for a FSL TCL GUI - here, we
+  # remove the _gui suffix if no source file
+  # exists (in which we are likely running on
+  # Linux).
   if [[ "$script" == *"_gui" ]] && [ ! -f "$sourceScript" ]; then
     script=${script/_gui/}
     sourceScript="${PREFIX}/bin/$script"