improve some commentaries

[tools/sat.git] / commands / log.py

diff --git a/commands/log.py b/commands/log.py
index 31d93e0053cbc92ee3d1afac57811c1002469442..3abe0f0addf26ca2cace015bbc1aa08e67492de8 100644 (file)
--- a/commands/log.py
+++ b/commands/log.py
@@ -1,5 +1,20 @@
 #!/usr/bin/env python
 #-*- coding:utf-8 -*-
+#  Copyright (C) 2010-2012  CEA/DEN
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 
 import os
 import shutil
@@ -49,6 +64,11 @@ def get_last_log_file(logDir, notShownCommands):
     return os.path.join(logDir, last[0])
 
 def remove_log_file(filePath, logger):
+    '''if it exists, print a warning and remove the input file
+    
+    :param filePath: the path of the file to delete
+    :param logger Logger: the logger instance to use for the print 
+    '''
     if os.path.exists(filePath):
         logger.write(src.printcolors.printcWarning("Removing ")
                      + filePath + "\n", 5)
@@ -120,7 +140,7 @@ def run(args, runner, logger):
     # get the log directory. 
     # If there is an application, it is in cfg.APPLICATION.out_dir, 
     # else in user directory
-    logDir = runner.cfg.SITE.log.logDir
+    logDir = runner.cfg.SITE.log.log_dir
 
     # If the clean options is invoked, 
     # do nothing but deleting the concerned files.
@@ -155,7 +175,7 @@ def run(args, runner, logger):
         return 0 
 
     # determine the commands to show in the hat log
-    notShownCommands = runner.cfg.INTERNAL.log.notShownCommands
+    notShownCommands = runner.cfg.INTERNAL.log.not_shown_commands
     if options.full:
         notShownCommands = []
 
@@ -219,7 +239,7 @@ def run(args, runner, logger):
                     
     # Create or update the hat xml that gives access to all the commands log files
     xmlHatFilePath = os.path.join(logDir, 'hat.xml')
-    src.logger.update_hat_xml(runner.cfg.SITE.log.logDir, 
+    src.logger.update_hat_xml(runner.cfg.SITE.log.log_dir, 
                               application = runner.cfg.VARS.application, 
                               notShownCommands = notShownCommands)