From 56d481785c11dd303fa2a37405f71a267e212541 Mon Sep 17 00:00:00 2001
From: Ray Speth <speth@mit.edu>
Date: Wed, 5 Jun 2013 17:09:39 +0000
Subject: [PATCH] Deprecate HTML log files

---
 SConstruct               | 8 +++++---
 src/base/application.cpp | 5 +++++
 src/base/application.h   | 7 +++++++
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/SConstruct b/SConstruct
index d41bae836..8618c685d 100644
--- a/SConstruct
+++ b/SConstruct
@@ -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')
diff --git a/src/base/application.cpp b/src/base/application.cpp
index a3789aa38..492dd6d85 100644
--- a/src/base/application.cpp
+++ b/src/base/application.cpp
@@ -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;
     }
diff --git a/src/base/application.h b/src/base/application.h
index 4f741da7c..da9c1b7b0 100644
--- a/src/base/application.h
+++ b/src/base/application.h
@@ -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