Deprecate HTML log files

This commit is contained in:
Ray Speth 2013-06-05 17:09:39 +00:00
parent 64bfdcc952
commit 56d481785c
3 changed files with 17 additions and 3 deletions

View file

@ -395,9 +395,9 @@ config_options = [
BoolVariable(
'with_html_log_files',
"""write HTML log files. Some multiphase equilibrium procedures can
write copious diagnostic log messages. Set this to 'n' to disable
this capability. (results in slightly faster equilibrium calculations)""",
True),
write copious diagnostic log messages. Deprecated -- to be removed
in Cantera 2.2.""",
False),
EnumVariable(
'use_sundials',
"""Cantera uses the CVODE or CVODES ODE integrator to time-integrate
@ -1091,6 +1091,8 @@ else:
cdefine('H298MODIFY_CAPABILITY', 'with_h298modify_capability')
cdefine('WITH_HTML_LOGS', 'with_html_log_files')
if env['with_html_log_files']:
print 'WARNING: Support for HTML log files is deprecated and will be removed in Cantera 2.2.'
cdefine('LAPACK_FTN_STRING_LEN_AT_END', 'lapack_ftn_string_len_at_end')
cdefine('LAPACK_FTN_TRAILING_UNDERSCORE', 'lapack_ftn_trailing_underscore')

View file

@ -153,6 +153,8 @@ void Application::Messages::writelogendl()
void Application::Messages::beginLogGroup(const std::string& title, int _loglevel /*=-99*/)
{
Cantera::warn_deprecated("Application::Messages::beginLogGroup",
"HTML Logs will be removed in Cantera 2.2");
// Add the current loglevel to the vector of loglevels
loglevels.push_back(loglevel);
@ -240,6 +242,9 @@ void Application::Messages::endLogGroup(const std::string& title)
void Application::Messages::write_logfile(const std::string& file)
{
Cantera::warn_deprecated("Application::Messages::write_logfile",
"HTML Logs will be removed in Cantera 2.2");
if (!xmllog) {
return;
}

View file

@ -173,6 +173,7 @@ protected:
* @param title String name of the LogGroup
* @param loglevel loglevel of the group.
* @ingroup HTML_logs
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void beginLogGroup(const std::string& title, int loglevel) ;
@ -184,6 +185,7 @@ protected:
* @param value string value
*
* @ingroup HTML_logs
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void addLogEntry(const std::string& tag, const std::string& value) ;
@ -195,6 +197,7 @@ protected:
* @param value double value
*
* @ingroup HTML_logs
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void addLogEntry(const std::string& tag, doublereal value) ;
@ -206,6 +209,7 @@ protected:
* @param value integer value
*
* @ingroup HTML_logs
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void addLogEntry(const std::string& tag, int value) ;
@ -216,6 +220,7 @@ protected:
* @param msg Message to be added
*
* @ingroup HTML_logs
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void addLogEntry(const std::string& msg) ;
@ -229,6 +234,7 @@ protected:
*
* @param title Name of the log group. It defaults to the most recent
* log group created.
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void endLogGroup(const std::string& title) ;
@ -244,6 +250,7 @@ protected:
* be defined.
*
* @param file Name of the file to be written
* @deprecated HTML logs will be removed in Cantera 2.2
*/
void write_logfile(const std::string& file);
#endif