From 7f379413417307ae1b551583e34eb6aea502a258 Mon Sep 17 00:00:00 2001
From: Nick Draper <nick.draper@stfc.ac.uk>
Date: Fri, 27 Jul 2018 10:37:10 +0100
Subject: [PATCH] Update docs, release notes, make python export handle the
optional arg
and improve the default user properties file.
re #23102
---
Framework/Kernel/src/ConfigService.cpp | 12 ++--
.../kernel/src/Exports/ConfigService.cpp | 2 +-
docs/source/concepts/PropertiesFile.rst | 30 +++-------
docs/source/release/v3.14.0/framework.rst | 56 +++++++++++++++++++
4 files changed, 71 insertions(+), 29 deletions(-)
diff --git a/Framework/Kernel/src/ConfigService.cpp b/Framework/Kernel/src/ConfigService.cpp
index 8dc730ca7a3..4ed9b933660 100644
--- a/Framework/Kernel/src/ConfigService.cpp
+++ b/Framework/Kernel/src/ConfigService.cpp
@@ -583,23 +583,21 @@ void ConfigServiceImpl::createUserPropertiesFile() const {
"installation.\n";
filestr << "# Any properties found in this file will override any that are "
"found in the Mantid.Properties file\n";
- filestr << "# As this file will not be replaced with futher installations "
+ filestr << "# As this file will not be replaced with further installations "
"of Mantid it is a safe place to put \n";
filestr << "# properties that suit your particular installation.\n";
filestr << "#\n";
filestr << "# See here for a list of possible options:\n";
filestr << "# "
- "http://www.mantidproject.org/"
- "Properties_File#Mantid.User.Properties\n\n";
+ "http://docs.mantidproject.org/nightly/concepts/PropertiesFile.html"
+ "\n\n";
filestr << "##\n";
filestr << "## GENERAL\n";
filestr << "##\n\n";
filestr << "## Set the number of algorithm properties to retain\n";
filestr << "#algorithms.retained=90\n\n";
- filestr << "## Hides catagories from the algorithm list in MantidPlot\n";
- filestr << "#algorithms.catagories.hidden=Muons,Inelastic\n\n";
filestr
- << "## Set the maximum number of coures used to run algorithms over\n";
+ << "## Set the maximum number of cores used to run algorithms over\n";
filestr << "#MultiThreaded.MaxCores=4\n\n";
filestr << "##\n";
filestr << "## FACILITY AND INSTRUMENT\n";
@@ -639,6 +637,8 @@ void ConfigServiceImpl::createUserPropertiesFile() const {
filestr << "##\n";
filestr << "## MantidPlot\n";
filestr << "##\n\n";
+ filestr << "## Hides categories from the algorithm list in MantidPlot\n";
+ filestr << "#algorithms.catagories.hidden=Muons,Inelastic\n\n";
filestr << "## Show invisible workspaces\n";
filestr << "#MantidOptions.InvisibleWorkspaces=0\n";
filestr << "## Re-use plot instances for different plot types\n";
diff --git a/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp b/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp
index 46bf4a16033..09a2393693b 100644
--- a/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp
+++ b/Framework/PythonInterface/mantid/kernel/src/Exports/ConfigService.cpp
@@ -163,7 +163,7 @@ void export_ConfigService() {
"filename")
.def("setLogLevel", &ConfigServiceImpl::setLogLevel,
- (arg("self"), arg("logLevel"), arg("quiet")),
+ (arg("self"), arg("logLevel"), arg("quiet") = false),
"Sets the log level priority for all the log channels, logLevel "
"1 = Fatal, 6 = information, 7 = Debug")
diff --git a/docs/source/concepts/PropertiesFile.rst b/docs/source/concepts/PropertiesFile.rst
index 46d6b547729..553631683f7 100644
--- a/docs/source/concepts/PropertiesFile.rst
+++ b/docs/source/concepts/PropertiesFile.rst
@@ -116,36 +116,22 @@ you may want to alter and those properties are detailed below.
+-------------------------------------------------+---------------------------------------------------+-----------------------------+
|Property |Description |Example value |
+=================================================+===================================================+=============================+
-| ``logging.loggers.root.level`` |Defines the lowest level of messages to be output | ``debug``, ``information``, |
-| |by the system, and will override lower settings in | ``notice``, ``warning``, |
-| |filterChannels. The default is information, but | ``error``, ``critical`` |
+| ``logging.loggers.root.level`` |Defines the level of messages to be output | ``debug``, ``information``, |
+| |by the system. | ``notice``, ``warning``, |
+| |The default is information, but | ``error``, ``critical`` |
| |this can be lowered to debug for more detailed | or ``fatal`` |
| |feedback. | |
| | | |
+-------------------------------------------------+---------------------------------------------------+-----------------------------+
-| ``logging.channels.fileFilterChannel.level`` | The lowest level messages to output to the log | ``debug``, ``information``, |
-| | file. The default is warning, but this can be | ``notice``, ``warning``, |
-| | lowered to debug for more detailed feedback. The | ``error``, ``critical`` |
-| | higher level of this and | or ``fatal`` |
-| | ``logging.loggers.root.level`` will apply. | |
-+-------------------------------------------------+---------------------------------------------------+-----------------------------+
-| ``logging.channels.consoleFilterChannel.level`` | The lowest level messages to output to the | ``debug``, ``information``, |
-| | console. The default is warning, but this can be | ``notice``, ``warning``, |
-| | lowered to debug for more detailed feedback. The | ``error``, ``critical`` |
-| | higher level of this and | or ``fatal`` |
-| | ``logging.loggers.root.level`` will apply. | |
-+-------------------------------------------------+---------------------------------------------------+-----------------------------+
-| ``logging.channels.fileChannel.path`` | The Path to the log file. | ``../logs/mantid.log`` |
-+-------------------------------------------------+---------------------------------------------------+-----------------------------+
-The logging priority levels for the file logging and console logging can also be adjusted in python using the commands:
+The logging priority levels for the file logging and console logging can also be adjusted in python using the command:
.. testcode:: LoggingConfigExample
- #Set the console to log at debug level on above (7=debug)
- ConfigService.setConsoleLogLevel(7)
- #Set the file to only log at critical level (2=critical)
- ConfigService.setConsoleLogLevel(2)
+ #Set the log to debug level or above (7=debug)
+ ConfigService.setLogLevel(7)
+ #Set the log to critical level (2=critical)
+ ConfigService.setLogLevel(2)
diff --git a/docs/source/release/v3.14.0/framework.rst b/docs/source/release/v3.14.0/framework.rst
index 87a09ca4ce0..4c29021bfc9 100644
--- a/docs/source/release/v3.14.0/framework.rst
+++ b/docs/source/release/v3.14.0/framework.rst
@@ -9,4 +9,60 @@ Framework Changes
putting new features at the top of the section, followed by
improvements, followed by bug fixes.
+Logging
+-------
+
+- We have changed the logging in Mantid to stop writing the a high level version of the log to a file. This had been causing numerous problems including inconsistent behaviour with multiple instances of Mantid, performance problems when logging at detailed levels, and excessive network usage in some scenarios. This does not change the rest of the logging that you see in the message display in Mantidplot or the console window.
+
+ - Associated with this we have also simplified the python methods used to control logging.
+
+ .. code-block:: python
+
+ # The two methods
+ ConfigService.SetConsoleLogLevel(int)
+ ConfigService.SetFileLogLevel(int)
+
+ # Have been replaced by
+ ConfigService.SetLogLevel(int)
+
+Stability
+---------
+
+
+
+
+Algorithms
+----------
+
+
+New Algorithms
+**************
+
+
+
+Improvements
+############
+
+
+Bugfixes
+########
+
+
+
+Python
+------
+
+New
+###
+
+
+Improvements
+############
+
+
+
+Bugfixes
+########
+
+
:ref:`Release 3.14.0 <v3.14.0>`
--
GitLab