[Logging-commits] r26 - pkg pkg/man www

[noreply at r-forge.r-project.org]

Author: mariotomo
Date: 2010-04-08 16:40:05 +0200 (Thu, 08 Apr 2010)
New Revision: 26

Modified:
   pkg/DESCRIPTION
   pkg/man/basicConfig.Rd
   pkg/man/getHandler.Rd
   www/additions.css
   www/sample_session.html
Log:
aligning the manual pages to the current implementation.
adding the Id keyword to files where it was missing.


Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION	2010-04-08 14:20:16 UTC (rev 25)
+++ pkg/DESCRIPTION	2010-04-08 14:40:05 UTC (rev 26)
@@ -1,5 +1,5 @@
 Package: logging
-Version: 0.4-23
+Version: 0.4-26
 Date: 2010-01-14
 Title: a tentative logging package
 Author: Mario Frasca <mariotomo at gmail.com>

Modified: pkg/man/basicConfig.Rd
===================================================================
--- pkg/man/basicConfig.Rd	2010-04-08 14:20:16 UTC (rev 25)
+++ pkg/man/basicConfig.Rd	2010-04-08 14:40:05 UTC (rev 26)
@@ -7,14 +7,32 @@
 \title{bootstrapping the logging package}
 \description{
 
-  create the root logger, attach it a console handler, set both at
-  logging.level INFO.
+  'basicConfig' and 'logReset' provide a way to put the logging package
+  in a know initial state.
+}
+\details{
+  \describe{
+    
+    \item{basicConfig}{creates the root logger, attaches a console
+      handler to it and sets the level of the handler to logging.level
+      INFO.  the level of the logger can be passed as a parameter to the
+      function.}
 
+    \item{logReset}{reinitializes the whole logging system as if the
+      package had just been loaded.  typically, you would want to call
+      basicConfig immediately after a call to logReset.}
+    
+  }  
 }
 \usage{
-basicConfig()
+basicConfig(level)
 logReset()
 }
+\arguments{
+  \item{level}{the logging level of the root logger.  defaults to INFO.
+  please do notice that this has no effect on the handling level of the
+  handler that basicConfig attaches to the root logger.}
+  }
 \examples{
 library(logging)
 basicConfig()

Modified: pkg/man/getHandler.Rd
===================================================================
--- pkg/man/getHandler.Rd	2010-04-08 14:20:16 UTC (rev 25)
+++ pkg/man/getHandler.Rd	2010-04-08 14:40:05 UTC (rev 26)
@@ -1,5 +1,5 @@
 % File src/R/man/getHandler.Rd
-% $Id: getLogger.Rd 11 2010-04-03 18:54:20Z mariotomo $
+% $Id$
 
 \name{getHandler}
 \alias{getHandler}


Property changes on: pkg/man/getHandler.Rd
___________________________________________________________________
Name: svn:keywords
   + Id


Property changes on: www/additions.css
___________________________________________________________________
Name: svn:keywords
   + Id


Property changes on: www/sample_session.html
___________________________________________________________________
Name: svn:keywords
   + Id