Replace todo direct access with consider methods; guided or not

[simgrid.git] / docs / bin / extract_logs_hierarchy.pl

diff --git a/docs/bin/extract_logs_hierarchy.pl b/docs/bin/extract_logs_hierarchy.pl
index a6f3dfe..40c74f8 100755 (executable)
--- a/docs/bin/extract_logs_hierarchy.pl
+++ b/docs/bin/extract_logs_hierarchy.pl
@@ -1,7 +1,6 @@
 #!/usr/bin/env perl
 
-# Copyright (c) 2008-2021. The SimGrid Team.
-# All rights reserved.
+# Copyright (c) 2008-2023. 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.
@@ -15,12 +14,15 @@ print ".. Generated file, do not edit \n\n";
 print ".. _logging_categories:\n\n";
 print "Existing categories\n";
 print "===================\n\n";
+print "This is the list of all categories existing in the SimGrid implementation. "
+  ."Some of them only exist with specific compile-time options, while your implementation may add new ones. "
+  ."Please add \`\`--help-log-categories\`\` to the command-line of a SimGrid simulator to see the exact list of categories usable with it.\n\n";
 
 # Search for calls to macros defining new channels, and prepare the tree representation
 my %ancestor;
 my %desc;
 # $ancestor{"toto"} is the ancestor of the toto channel as declared by XBT_LOG_NEW_SUBCATEGORY and
-# XBT_LOG_NEW_DEFAULT_SUBCATEGORY ie, when the channel toto is initialized (does not work under windows)
+# XBT_LOG_NEW_DEFAULT_SUBCATEGORY ie, when the channel toto is initialized
 
 # $desc{"toto"} is its description
 
@@ -81,7 +83,7 @@ my $path = $ARGV[0] // "..";
 open FILES, "find $path/src/ $path/tools/ $path/include/ -name '*.c' -o -name '*.cpp' |" || die "Cannot search for the source file names: $!\n";
 while (my $file=<FILES>) {
     chomp $file;
-    parse_file($file);         
+    parse_file($file);
 }
 parse_file("$path/include/xbt/sysdep.h");
 close FILES;
@@ -92,7 +94,7 @@ my %used;
 sub display_subtree {
     my $name=shift;
     my $indent=shift;
-    
+
     $used{$name} = 1;
     unless ($name eq "XBT_LOG_ROOT_CAT") { # do not display the root
        print "$indent - $name: ".($desc{$name}|| "(undocumented)")."\n";