Merged Keenan Lang's iocsh-silent branch

documentation/RELEASE_NOTES.html

@@ -20,6 +20,13 @@
 
 -->
 
+<h3>Echoless comments in iocsh</h3>
+
+<p>The way comments are parsed by the iocsh interpreter has changed. The
+interpreter can be selectively disabled from echoing comments coming from
+a script by starting those lines with '#-' rather than just '#'.</p>
+
+
 <h2 align="center">Changes pulled from the 3.15 branch since 3.16.0.1</h2>
 <!-- Insert inherited items immediately below here ... -->
 

src/libCom/iocsh/iocsh.cpp

@@ -611,12 +611,13 @@ iocshBody (const char *pathname, const char *commandLine, const char *macros)
 
         /*
          * Ignore comment lines other than to echo
-         * them if they came from a script.  This
-         * avoids macLib errors from comments.
+         * them if they came from a script (disable echoing
+         * with '#-').  This avoids macLib errors from comments.
          */
         if (c == '#') {
             if ((prompt == NULL) && (commandLine == NULL))
-                puts(raw);
+                if (raw[icin + 1] != '-')
+                    puts(raw);
             continue;
         }
 
@@ -635,10 +636,12 @@ iocshBody (const char *pathname, const char *commandLine, const char *macros)
         }
 
         /*
-         * Echo non-empty lines read from a script
+         * Echo non-empty lines read from a script.
+         * Comments delineated with '#-' aren't echoed.
          */
         if ((prompt == NULL) && *line && (commandLine == NULL))
-            puts(line);
+            if ((c != '#') || (line[icin + 1] != '-'))
+                puts(line);
 
         /*
          * Ignore lines that became a comment or empty after macro expansion

src/template/base/top/exampleBoot/ioc/st.cmd@Common

@@ -1,7 +1,7 @@
 #!../../bin/_ARCH_/_APPNAME_
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 
 < envPaths
 
@@ -16,10 +16,10 @@ dbLoadTemplate "db/user.substitutions"
 dbLoadRecords "db/_APPNAME_Version.db", "user=_USER_"
 dbLoadRecords "db/dbSubExample.db", "user=_USER_"
 
-## Set this to see messages from mySub
+#- Set this to see messages from mySub
 #var mySubDebug 1
 
-## Run this to trace the stages of iocInit
+#- Run this to trace the stages of iocInit
 #traceIocInit
 
 cd "${TOP}/iocBoot/${IOC}"

src/template/base/top/exampleBoot/ioc/st.cmd@RTEMS

@@ -1,7 +1,7 @@
-## Example RTEMS startup script
+#- Example RTEMS startup script
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 
 #< envPaths
 
@@ -14,10 +14,10 @@ dbLoadTemplate("db/user.substitutions")
 dbLoadRecords("db/_APPNAME_Version.db", "user=_USER_")
 dbLoadRecords("db/dbSubExample.db", "user=_USER_")
 
-## Set this to see messages from mySub
+#- Set this to see messages from mySub
 #var mySubDebug 1
 
-## Run this to trace the stages of iocInit
+#- Run this to trace the stages of iocInit
 #traceIocInit
 
 iocInit

src/template/base/top/exampleBoot/ioc/st.cmd@vxWorks

@@ -1,7 +1,7 @@
-## Example vxWorks startup file
+#- Example vxWorks startup file
 
-## The following is needed if your board support package doesn't at boot time
-## automatically cd to the directory containing its startup script
+#- The following is needed if your board support package doesn't at boot time
+#- automatically cd to the directory containing its startup script
 #cd "_TOP_/iocBoot/_IOC_"
 
 < cdCommands
@@ -9,8 +9,8 @@
 
 cd topbin
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 ld 0,0, "_APPNAME_.munch"
 
 ## Register all support components
@@ -23,10 +23,10 @@ dbLoadTemplate "db/user.substitutions"
 dbLoadRecords "db/_APPNAME_Version.db", "user=_USER_"
 dbLoadRecords "db/dbSubExample.db", "user=_USER_"
 
-## Set this to see messages from mySub
+#- Set this to see messages from mySub
 #mySubDebug = 1
 
-## Run this to trace the stages of iocInit
+#- Run this to trace the stages of iocInit
 #traceIocInit
 
 cd startup

src/template/base/top/exampleBoot/nfsCommands@RTEMS

@@ -1,26 +1,26 @@
-#Instructions for creating and using a real nfsCommands file
-# 
-# in order to use nfs do the following:
-# 1) Create hostAdd and nfsMount commands for each nfs server
-# 2) In each st.cmd file add the following two commands BEFORE any load commands
-#    ../nfs.cmd
-#    cd "<iocname>
-# 
-# The hostAdd command has the form:
-# hostAdd("<host>","xxx.xxx.xxx.xxx")
-# 
-# You can also mount subdirectories as follows:
-# nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
-# 
-# For example assume
-# 
-# host is mercury with inet address 155.77.2.56
-# You want to mount the directory (which is a file system of mercury)
-# /home/mercury5/iocinfo
-#    as
-# /iocinfo
-# 
-# The commands would be
-# 
-# hostAdd("mercury","155.77.2.56")
-# nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")
+#- Instructions for creating and using a real nfsCommands file
+#- 
+#- in order to use nfs do the following:
+#- 1) Create hostAdd and nfsMount commands for each nfs server
+#- 2) In each st.cmd file add the following two commands BEFORE any load commands
+#-    ../nfs.cmd
+#-    cd "<iocname>
+#- 
+#- The hostAdd command has the form:
+#- hostAdd("<host>","xxx.xxx.xxx.xxx")
+#- 
+#- You can also mount subdirectories as follows:
+#- nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
+#- 
+#- For example assume
+#- 
+#- host is mercury with inet address 155.77.2.56
+#- You want to mount the directory (which is a file system of mercury)
+#- /home/mercury5/iocinfo
+#-    as
+#- /iocinfo
+#- 
+#- The commands would be
+#- 
+#- hostAdd("mercury","155.77.2.56")
+#- nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")

src/template/base/top/exampleBoot/nfsCommands@vxWorks

@@ -1,29 +1,29 @@
-#Instructions for creating and using a real nfsCommands file
-# 
-# in order to use nfs do the following:
-# 1) Create hostAdd and nfsMount commands for each nfs server
-# 2) In each st.cmd file add the following two commands BEFORE any load commands
-#    ../nfs.cmd
-#    cd "<iocname>
-# 
-# The hostAdd command has the form:
-# hostAdd("<host>","xxx.xxx.xxx.xxx")
-#
-# The nfsMount command has the form:
-# nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
-# 
-# You can also mount subdirectories as follows:
-# nfsMountAll("<host>")
-# 
-# For example assume
-# 
-# host is mercury with inet address 155.77.2.56
-# You want to mount the directory (which is a file system of mercury)
-# /home/mercury5/iocinfo
-#    as
-# /iocinfo
-# 
-# The commands would be
-# 
-# hostAdd("mercury","155.77.2.56")
-# nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")
+#- Instructions for creating and using a real nfsCommands file
+#- 
+#- in order to use nfs do the following:
+#- 1) Create hostAdd and nfsMount commands for each nfs server
+#- 2) In each st.cmd file add the following two commands BEFORE any load commands
+#-    ../nfs.cmd
+#-    cd "<iocname>
+#- 
+#- The hostAdd command has the form:
+#- hostAdd("<host>","xxx.xxx.xxx.xxx")
+#-
+#- The nfsMount command has the form:
+#- nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
+#- 
+#- You can also mount subdirectories as follows:
+#- nfsMountAll("<host>")
+#- 
+#- For example assume
+#- 
+#- host is mercury with inet address 155.77.2.56
+#- You want to mount the directory (which is a file system of mercury)
+#- /home/mercury5/iocinfo
+#-    as
+#- /iocinfo
+#- 
+#- The commands would be
+#- 
+#- hostAdd("mercury","155.77.2.56")
+#- nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")

src/template/base/top/iocBoot/ioc/st.cmd@Common

@@ -1,7 +1,7 @@
 #!../../bin/_ARCH_/_APPNAME_
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 
 < envPaths
 

src/template/base/top/iocBoot/ioc/st.cmd@Cross

@@ -1,7 +1,7 @@
 #!../../bin/_ARCH_/_APPNAME_
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 
 #< envPaths
 

src/template/base/top/iocBoot/ioc/st.cmd@RTEMS

@@ -1,7 +1,7 @@
-## Example RTEMS startup script
+#- Example RTEMS startup script
 
-## You may have to change _APPNAME_ to something else
-## everywhere it appears in this file
+#- You may have to change _APPNAME_ to something else
+#- everywhere it appears in this file
 
 #< envPaths
 

src/template/base/top/iocBoot/ioc/st.cmd@vxWorks

@@ -1,7 +1,7 @@
-## Example vxWorks startup file
+#- Example vxWorks startup file
 
-## The following is needed if your board support package doesn't at boot time
-## automatically cd to the directory containing its startup script
+#- The following is needed if your board support package doesn't at boot time
+#- automatically cd to the directory containing its startup script
 #cd "_TOP_/iocBoot/_IOC_"
 
 < cdCommands

src/template/base/top/iocBoot/nfsCommands@RTEMS

@@ -1,29 +1,29 @@
-#Instructions for creating and using a real nfsCommands file
-# 
-# in order to use nfs do the following:
-# 1) Create hostAdd and nfsMount commands for each nfs server
-# 2) In each st.cmd file add the following two commands BEFORE any load commands
-#    ../nfs.cmd
-#    cd "<iocname>
-# 
-# The hostAdd command has the form:
-# hostAdd("<host>","xxx.xxx.xxx.xxx")
-# 
-# The vxWorks nfsMount command has the form:
-# nfsMount("<host>")
-#
-# You can also mount subdirectories as follows:
-# nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
-# 
-# For example assume
-# 
-# host is mercury with inet address 155.77.2.56
-# You want to mount the directory (which is a file system of mercury)
-# /home/mercury5/iocinfo
-#    as
-# /iocinfo
-# 
-# The commands would be
-# 
-# hostAdd("mercury","155.77.2.56")
-# nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")
+#- Instructions for creating and using a real nfsCommands file
+#- 
+#- in order to use nfs do the following:
+#- 1) Create hostAdd and nfsMount commands for each nfs server
+#- 2) In each st.cmd file add the following two commands BEFORE any load commands
+#-    ../nfs.cmd
+#-    cd "<iocname>
+#- 
+#- The hostAdd command has the form:
+#- hostAdd("<host>","xxx.xxx.xxx.xxx")
+#- 
+#- The vxWorks nfsMount command has the form:
+#- nfsMount("<host>")
+#-
+#- You can also mount subdirectories as follows:
+#- nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
+#- 
+#- For example assume
+#- 
+#- host is mercury with inet address 155.77.2.56
+#- You want to mount the directory (which is a file system of mercury)
+#- /home/mercury5/iocinfo
+#-    as
+#- /iocinfo
+#- 
+#- The commands would be
+#- 
+#- hostAdd("mercury","155.77.2.56")
+#- nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")

src/template/base/top/iocBoot/nfsCommands@vxWorks

@@ -1,29 +1,29 @@
-#Instructions for creating and using a real nfsCommands file
-# 
-# in order to use nfs do the following:
-# 1) Create hostAdd and nfsMount commands for each nfs server
-# 2) In each st.cmd file add the following two commands BEFORE any load commands
-#    ../nfs.cmd
-#    cd "<iocname>
-# 
-# The hostAdd command has the form:
-# hostAdd("<host>","xxx.xxx.xxx.xxx")
-# 
-# The vxWorks nfsMount command has the form:
-# nfsMount("<host>")
-#
-# You can also mount subdirectories as follows:
-# nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
-# 
-# For example assume
-# 
-# host is mercury with inet address 155.77.2.56
-# You want to mount the directory (which is a file system of mercury)
-# /home/mercury5/iocinfo
-#    as
-# /iocinfo
-# 
-# The commands would be
-# 
-# hostAdd("mercury","155.77.2.56")
-# nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")
+#- Instructions for creating and using a real nfsCommands file
+#- 
+#- in order to use nfs do the following:
+#- 1) Create hostAdd and nfsMount commands for each nfs server
+#- 2) In each st.cmd file add the following two commands BEFORE any load commands
+#-    ../nfs.cmd
+#-    cd "<iocname>
+#- 
+#- The hostAdd command has the form:
+#- hostAdd("<host>","xxx.xxx.xxx.xxx")
+#- 
+#- The vxWorks nfsMount command has the form:
+#- nfsMount("<host>")
+#-
+#- You can also mount subdirectories as follows:
+#- nfsMount("<host>", "/xxx/xxx/xxx", "/xxx")
+#- 
+#- For example assume
+#- 
+#- host is mercury with inet address 155.77.2.56
+#- You want to mount the directory (which is a file system of mercury)
+#- /home/mercury5/iocinfo
+#-    as
+#- /iocinfo
+#- 
+#- The commands would be
+#- 
+#- hostAdd("mercury","155.77.2.56")
+#- nfsMount("mercury","/home/mercury5/iocinfo","/iocinfo")