Merge pull request #2501 from matthewrmshin/improve-doc-terminology

Improve doc and terminology

bin/cylc-documentation

@@ -25,8 +25,8 @@ View documentation in browser or PDF viewer, as per Cylc global config.
 
 % cylc doc [-t TASK] SUITE
     View suite or task documentation, if URLs are specified in the suite. This
-parses the suite definition to extract the requested URL. Note that running
-suite daemons also hold suite URLs for access from the Cylc GUI.
+parses the suite definition to extract the requested URL. Note that suite
+server programs also hold suite URLs for access from the Cylc GUI.
 
 Arguments:
    [TARGET]    File, URL, or suite name"""

bin/cylc-ext-trigger

@@ -18,8 +18,8 @@
 
 """cylc [control] ext-trigger [OPTIONS] ARGS
 
-Report an external event message to a suite daemon. It is expected that a
-task in the suite has registered the same message as an external trigger - a
+Report an external event message to a suite server program. It is expected that
+a task in the suite has registered the same message as an external trigger - a
 special prerequisite to be satisifed by an external system, via this command,
 rather than by triggering off other tasks.
 

bin/cylc-help

@@ -388,8 +388,9 @@ comsum['monitor'] = 'An in-terminal suite monitor (see also gcylc)'
 comsum['get-suite-config'] = 'Print suite configuration items'
 comsum['get-site-config'] = 'Print site/user configuration items'
 comsum['get-gui-config'] = 'Print gcylc configuration items'
-comsum['get-suite-contact'] = 'Print the contact information of a suite daemon'
-comsum['get-suite-version'] = 'Print the cylc version of a suite daemon'
+comsum['get-suite-contact'] = (
+    'Print contact information of a suite server program')
+comsum['get-suite-version'] = 'Print cylc version of a suite server program'
 comsum['version'] = 'Print the cylc release version'
 comsum['gscan'] = 'Scan GUI for monitoring multiple suites'
 comsum['gpanel'] = 'Internal interface for GNOME 2 panel applet'

bin/cylc-message

@@ -19,7 +19,7 @@
 
 This command is used by task jobs to automatically report success and failure.
 
-It can also be used to send info-, warning-, or critical-priority messages
+It can also be used to send info-, warning-, or critical-severity messages
 back, and to report registered task "message outputs" completed.
 
 Note: to abort a job script with a custom error message, use cylc__job_abort:
@@ -39,17 +39,18 @@ def main():
     parser = OptionParser(__doc__)
 
     parser.add_option(
-        "-p", "--priority", metavar="PRIORITY", type="choice",
+        "-s", "--severity", "-p", "--priority",
+        metavar="SEVERITY", type="choice",
         choices=['NORMAL', 'WARNING', 'CRITICAL', 'CUSTOM'],
-        help="message priority: NORMAL, WARNING, or CRITICAL; default NORMAL.",
-        action="store", dest="priority", default="NORMAL")
+        help="message severity: NORMAL (default), WARNING, CRITICAL or CUSTOM",
+        action="store", dest="severity", default="NORMAL")
 
     parser.add_option(
         "--env", help="Override environment variables", action="append",
         default=[], dest="env")
 
     parser.add_option(
-        "-v", "--verbose", help="Verbose output mode.", action="store_true",
+        "-v", "--verbose", help="Verbose output mode", action="store_true",
         default=False, dest="verbose")
 
     options, args = parser.parse_args()
@@ -59,7 +60,7 @@ def main():
     for item in options.env:
         key, value = item.split('=', 1)
         os.environ[key] = value
-    task_message = TaskMessage(priority=options.priority)
+    task_message = TaskMessage(severity=options.severity)
     if (task_message.env_map.get('CYLC_VERBOSE') in ["True", "true"] or
             options.verbose):
         cylc.flags.verbose = True

bin/cylc-set-verbosity

@@ -18,8 +18,8 @@
 
 """cylc [control] set-verbosity [OPTIONS] ARGS
 
-Change the logging priority level of a running suite.  Only messages at
-or above the chosen priority level will be logged; for example, if you
+Change the logging severity level of a running suite.  Only messages at
+or above the chosen severity level will be logged; for example, if you
 choose WARNING, only warnings and critical messages will be logged."""
 
 from logging import CRITICAL, ERROR, WARNING, INFO, DEBUG
@@ -57,20 +57,20 @@ def main():
     (options, args) = parser.parse_args()
     suite = args[0]
 
-    priority_str = args[1]
+    severity_str = args[1]
     try:
-        priority = LOGGING_LVL_OF[priority_str]
+        severity = LOGGING_LVL_OF[severity_str]
     except KeyError:
-        parser.error("Illegal logging level, %s" % priority)
+        parser.error("Illegal logging level, %s" % severity)
 
-    prompt("Set logging level to %s in %s" % (priority_str, suite),
+    prompt("Set logging level to %s in %s" % (severity_str, suite),
            options.force)
     pclient = SuiteRuntimeServiceClient(
         suite, options.owner, options.host, options.port,
         options.comms_timeout, my_uuid=options.set_uuid,
         print_uuid=options.print_uuid)
 
-    pclient.put_command('set_verbosity', level=priority)
+    pclient.put_command('set_verbosity', level=severity)
 
 
 if __name__ == "__main__":

bin/cylc-show

@@ -18,8 +18,8 @@
 
 """cylc [info] show [OPTIONS] ARGS
 
-Interrogate a suite daemon for the suite title and description; or for the
-title and description of one of its tasks; or for the current state of the
+Interrogate a suite server program for the suite title and description; or for
+the title and description of one of its tasks; or for the current state of the
 prerequisites, outputs, and clock-triggering of a specific task instance."""
 
 import sys

bin/cylc-stop

@@ -18,7 +18,7 @@
 
 """cylc [control] stop|shutdown [OPTIONS] ARGS
 
-Tell a running suite daemon to shut down. In order to prevent failures going
+Tell a suite server program to shut down. In order to prevent failures going
 unnoticed, suites only shut down automatically at a final cycle point if no
 failed tasks are present. There are several shutdown methods:
 

bin/cylc-trigger

@@ -97,8 +97,8 @@ def main():
         if not success:
             sys.exit('ERROR: %s' % msg)
 
-        # Get the job filename from the suite daemon - the task cycle point may
-        # need standardising to the suite cycle point format.
+        # Get the job filename from the suite server program - the task cycle
+        # point may need standardising to the suite cycle point format.
         jobfile_path = pclient.get_info(
             'get_task_jobfile_path', task_id=task_id)
         if not jobfile_path:
@@ -115,7 +115,7 @@ def main():
         except OSError:
             old_mtime = None
 
-        # Tell the suite daemon to generate the job file.
+        # Tell the suite server program to generate the job file.
         pclient.put_command('dry_run_tasks', items=[task_id])
 
         # Wait for the new job file to be written. Use mtime because the same

bin/cylc-version

@@ -24,7 +24,7 @@ Note that "cylc -v,--version" just prints the version string from the main
 command interface, whereas this is a proper cylc command that can take the
 standard --host and --user options, etc.
 
-For the cylc version of running a suite daemon see
+For the cylc version of running a suite server program, see
   "cylc get-suite-version"."""
 
 import sys