Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #168 from simgrid/smpi_huge_pages
[simgrid.git] / include / xbt / log.h
index 93dabef..a6be428 100644 (file)
@@ -1,7 +1,6 @@
 /* log - a generic logging facility in the spirit of log4j                  */
 
-/* Copyright (c) 2004-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2015. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
  *  This is the list of all existing log categories in SimGrid.
  *  This list is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility.
  *
- *  You can thus be certain that it is uptodate, but it may somehow lack a final manual touch.
- *  Anyway, nothing's perfect ;)
+ *  It should thus contain every categories that are defined in the SimGrid library. 
+ *  If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your simulator.
  */
 
 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
-   printf function. Useful to debug the logging facilities themselves */
-#undef XBT_LOG_MAYDAY
+   printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */
 //#define XBT_LOG_MAYDAY
 
-#ifndef _XBT_LOG_H_
-#define _XBT_LOG_H_
+#ifndef XBT_LOG_H
+#define XBT_LOG_H
 
 #include "xbt/misc.h"
 #include <stdarg.h>
@@ -323,6 +321,7 @@ XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender2_file_new(char *arg,int roll);
 /* ********************************** */
 /* Functions that you shouldn't call  */
 /* ********************************** */
+XBT_PUBLIC(void) xbt_log_init(int *argc, char **argv);
 XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
 XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority);