merging docs updates

surak · Jun 2, 2024 · ac0aa97 · ac0aa97
2 parents 88f74e5 + 28a7c79
commit ac0aa97
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/docs/source/040_FAQ.rst b/docs/source/040_FAQ.rst
@@ -362,7 +362,6 @@ reliably in a software hierarchy?
 
    and not the other way around.
 
-
 How does one handle backslashed characters (aka escaped characters) in an environment variable?
 
    Lua not Lmod is particular about \\<char>.  In other words, you

diff --git a/docs/source/250_site_package.rst b/docs/source/250_site_package.rst
@@ -21,9 +21,27 @@ two suggestions on how to use your SitePackage.lua file
       (for csh)
       setenv LMOD_PACKAGE_PATH /path/to/the/Site/Directory
 
-   A "SitePackage.lua" in that directory will override the one in the Lmod
-   install directory.
+A "SitePackage.lua" in that directory will override the one in the Lmod
+install directory.  In other words, you only get one
+"SitePackage.lua" file.  Suppose that your site has a system
+SitePackage.lua which you want to extend and not override.  Suppose
+that your site's SitePackage.lua is in /etc/lmod and you set::
 
+    export LMOD_PACKAGE_PATH=/home/user/Lmod
+
+Then in /home/user/Lmod do::
+
+    % ln -s /etc/lmod/SitePackage.lua /home/user/Lmod/Site.lua
+
+Then inside your /home/user/Lmod/SitePackage.lua do::
+
+    require("Site")
+
+Each require statement can only ``require'' one name.  So make sure
+that you symlink to a new name in your personal SitePackage.lua directory.
+    
+Checking if you have setup SitePackage.lua correctly
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You should check to see that Lmod finds your SitePackage.lua.  If you do::