From 9bcf3ef1cfc9dc47405ac4ead358a6665b756645 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Fri, 7 Dec 2012 23:23:59 +0100 Subject: [PATCH 1/1] take care of the generation of doc/doxygen/logcategories.doc after last cleanup --- .gitignore | 17 +-- buildtools/Cmake/GenerateDoc.cmake | 4 +- doc/Doxyfile.in | 2 +- doc/doxygen/logcategories.doc | 144 --------------------- tools/doxygen/xbt_log_extract_hierarchy.pl | 2 +- 5 files changed, 6 insertions(+), 163 deletions(-) delete mode 100644 doc/doxygen/logcategories.doc diff --git a/.gitignore b/.gitignore index 1b8856c339..0d0cf6ff88 100644 --- a/.gitignore +++ b/.gitignore @@ -102,24 +102,9 @@ doc/dev_guide/html doc/dev_guide/latex doc/index.php doc/simgrid.tag -doc/ref_guide/doxygen/RefGuideDoxyfile -doc/user_guide/doxygen/UserGuideDoxyfile -doc/dev_guide/doxygen/DevGuideDoxyfile -doc/ref_guide/doxygen/logcategories.doc -doc/user_guide/doxygen/logcategories.doc -doc/dev_guide/doxygen/logcategories.doc -doc/ref_guide/doxygen/simgrid_modules.map -doc/user_guide/doxygen/simgrid_modules.map -doc/dev_guide/doxygen/simgrid_modules.map +doc/doxygen/logcategories.doc doc/index-API.doc -doc/ref_guide/doxygen/index-API.doc -doc/user_guide/doxygen/index-API.doc -doc/dev_guide/doxygen/index-API.doc doc/simgrid_modules.map -doc/logcategories.doc -doc/shared/doxygen/simgridrefguide.tag -doc/shared/doxygen/simgriduserguide.tag -doc/shared/doxygen/simgriddevguide.tag ################################################ ### Specific of project diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index 80e05f9b02..9c56f37274 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -56,8 +56,10 @@ if(DOXYGEN_PATH) COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index file" + COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files" COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc + COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index d00d3f1c86..17ade966a7 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -686,7 +686,7 @@ INPUT = doxygen/index.doc \ doxygen/module-simix.doc \ doxygen/module-trace.doc \ index-API.doc \ - @top_srcdir@/doc/ref_guide/doxygen/logcategories.doc \ + @top_srcdir@/doc/doxygen/logcategories.doc \ @top_srcdir@/src/instr/ \ @top_srcdir@/include/ \ @top_srcdir@/include/msg \ diff --git a/doc/doxygen/logcategories.doc b/doc/doxygen/logcategories.doc deleted file mode 100644 index ddc5b37a2f..0000000000 --- a/doc/doxygen/logcategories.doc +++ /dev/null @@ -1,144 +0,0 @@ -/* Generated file, do not edit */ -/** \addtogroup XBT_log_cats - @{ - - amok: All AMOK categories - - amok_bw: Bandwidth testing - - amok_bw_sat: Everything concerning the SATuration part of the amok_bw module - - amok_pm: peer management - - bindings: All bindings categories - - lua: Lua Bindings - - lua_comm: Lua bindings (comm module) - - lua_host: Lua bindings (host module) - - lua_platf: Lua bindings (platform module) - - lua_process: Lua Bindings (process module) - - lua_state_cloner: Lua state management - - lua_task: Lua bindings (task module) - - lua_utils: Lua helper functions - - graphicator: Graphicator Logging System - - gras: All GRAS categories (cf. section \ref GRAS_API) - - gras_modules: Module and moddata handling - - gras_msg: High level messaging - - gras_msg_read: Message reader thread - - gras_msg_rpc: RPC mecanism - - gras_timer: Delayed and repetitive actions - - gras_trp: Conveying bytes over the network - - gras_trp_file: Pseudo-transport to write to/read from a file - - gras_trp_sg: SimGrid pseudo-transport - - gras_virtu: Virtualization code - - gras_virtu_emul: Emulation support - - gras_virtu_process: Process manipulation code - - stubgen: Stub generator - - instr: Logging the behavior of the tracing system (used for Visualization/Analysis of simulations) - - instr_paje_trace: Paje tracing event system - - instr_smpi: Tracing SMPI - - instr_surf: Tracing Surf - - jedule: Logging specific to Jedule - - jed_out: Logging specific to Jedule output - - jed_sd: Logging specific to Jedule SD binding - - mc: All MC categories - - mc_checkpoint: Logging specific to mc_checkpoint - - mc_dpor: Logging specific to MC DPOR exploration - - mc_global: Logging specific to MC (global) - - mc_liveness: Logging specific to algorithms for liveness properties verification - - mc_memory: Logging specific to MC (memory) - - mc_memory_map: Logging specific to algorithms for memory_map - - mc_request: Logging specific to MC (request) - - msg: All MSG categories - - msg_action: MSG actions for trace driven simulation - - msg_gos: Logging specific to MSG (gos) - - msg_io: Logging specific to MSG (io) - - msg_kernel: Logging specific to MSG (kernel) - - msg_mailbox: Logging specific to MSG (mailbox) - - msg_process: Logging specific to MSG (process) - - msg_task: Logging specific to MSG (task) - - msg_vm: Cloud-oriented parts of the MSG API - - sd: Logging specific to SimDag - - sd_daxparse: Parsing DAX files - - sd_dotparse: Parsing DOT files - - sd_kernel: Logging specific to SimDag (kernel) - - sd_task: Logging specific to SimDag (task) - - sd_workstation: Logging specific to SimDag (workstation) - - simix: All SIMIX categories - - simix_context: Context switching mechanism - - simix_deployment: Logging specific to SIMIX (deployment) - - simix_environment: Logging specific to SIMIX (environment) - - simix_host: Logging specific to SIMIX (hosts) - - simix_io: Logging specific to SIMIX (io) - - simix_kernel: Logging specific to SIMIX (kernel) - - simix_network: Logging specific to SIMIX (network) - - simix_process: Logging specific to SIMIX (process) - - simix_smurf: Logging specific to SIMIX (SMURF) - - simix_synchro: Logging specific to SIMIX (synchronization) - - smpi: All SMPI categories - - smpi_base: Logging specific to SMPI (base) - - smpi_bench: Logging specific to SMPI (benchmarking) - - smpi_coll: Logging specific to SMPI (coll) - - smpi_comm: Logging specific to SMPI (comm) - - smpi_group: Logging specific to SMPI (group) - - smpi_kernel: Logging specific to SMPI (kernel) - - smpi_mpi: Logging specific to SMPI (mpi) - - smpi_mpi_dt: Logging specific to SMPI (datatype) - - smpi_pmpi: Logging specific to SMPI (pmpi) - - surf: All SURF categories - - random: Random part of surf - - surf_config: About the configuration of surf (and the rest of the simulation) - - surf_cpu: Logging specific to the SURF CPU IMPROVED module - - surf_cpu_ti: Logging specific to the SURF CPU TRACE INTEGRATION module - - surf_kernel: Logging specific to SURF (kernel) - - surf_lagrange: Logging specific to SURF (lagrange) - - surf_lagrange_dichotomy: Logging specific to SURF (lagrange dichotomy) - - surf_maxmin: Logging specific to SURF (maxmin) - - surf_network: Logging specific to the SURF network module - - surf_network_gtnets: Logging specific to the SURF network GTNetS module - - surf_network_ns3: Logging specific to the SURF network NS3 module - - surf_parse: Logging specific to the SURF parsing module - - surf_route: Routing part of surf - - surf_routing_generic: Generic implementation of the surf routing - - surf_route_cluster: Routing part of surf - - surf_route_dijkstra: Routing part of surf -- dijkstra routing logic - - surf_route_floyd: Routing part of surf - - surf_route_full: Routing part of surf - - surf_route_none: Routing part of surf - - surf_route_rulebased: Routing part of surf - - surf_route_vivaldi: Routing part of surf - - surf_storage: Logging specific to the SURF storage module - - surf_trace: Surf trace management - - surf_workstation: Logging specific to the SURF workstation module - - tesh: TEst SHell utility - - xbt: All XBT categories (simgrid toolbox) - - graphxml_parse: Logging specific to the graphxml parsing module - - log: Loggings from the logging mechanism itself - - mm_diff: Logging specific to mm_diff in mmalloc - - module: module handling - - peer: peer management - - replay: Replay trace reader - - strbuff: String buffers - - xbt_cfg: configuration support - - xbt_ddt: Data description - - xbt_ddt_cbps: callback persistent state - - xbt_ddt_convert: Inter-architecture convertions - - xbt_ddt_create: Creating new data descriptions - - xbt_ddt_exchange: Sending data over the network - - xbt_ddt_parse: Parsing C data structures to build XBT data description - - xbt_ddt_lexer: The crude internals of the lexer used for type parsing - - xbt_dict: Dictionaries provide the same functionalities than hash tables - - xbt_dict_cursor: To traverse dictionaries - - xbt_dict_elm: Dictionaries internals - - xbt_dict_multi: Dictionaries of multiple keys - - xbt_dyn: Dynamic arrays - - xbt_ex: Exception mecanism - - xbt_fifo: FIFO - - xbt_graph: Graph - - xbt_lib: A dict with keys of type (name, level) - - xbt_mallocator: Mallocators - - xbt_matrix: 2D data storage - - xbt_parmap: parmap: parallel map - - xbt_parmap_unit: parmap unit testing - - xbt_queue: Message exchanging queue - - xbt_set: set: data container consisting in dict+dynar - - xbt_sync: Synchronization mechanism - - xbt_sync_os: Synchronization mechanism (OS-level) - - xbt_trp: Conveying bytes over the network - - xbt_trp_meas: Conveying bytes over the network without formating for perf measurements - - xbt_trp_tcp: TCP buffered transport -@}*/ diff --git a/tools/doxygen/xbt_log_extract_hierarchy.pl b/tools/doxygen/xbt_log_extract_hierarchy.pl index 9801be36ce..8544ab92d1 100755 --- a/tools/doxygen/xbt_log_extract_hierarchy.pl +++ b/tools/doxygen/xbt_log_extract_hierarchy.pl @@ -86,7 +86,7 @@ sub parse_file { } # Retrieve all the file names, and add their content to $data my $data; -open FILES, "find src/ tools/ include/ -name '*.c'|" || die "Cannot search for the source file names: $!\n"; +open FILES, "find ../src/ ../tools/ ../include/ -name '*.c'|" || die "Cannot search for the source file names: $!\n"; while (my $file=) { chomp $file; parse_file($file); -- 2.20.1