| | 1 | == Documentation Generation Log == |
| | 2 | |
| | 3 | This log contains information about the generation process itself and is provided initially in the form of console messages which indicate the progress of the documentation generation process and show any errors or problems that are encountered during in the process. This log was also exported as an XML file for convenience and automated post-processing by third party tools. As of v1.0.0 this is no longer the case. The generation of an XML log file has been suspended until such functionality is reintegrated into the new common logging interface. The log file file was called {{{log.xml}}} and was located in the target directory where the other XML files from the main output are located as well. The particular format of the log messages will be described in more detail in the relevant sections concerning the causes and contexts of their occurrence. Ultimately, all messages shall have a uniform format, however currently some of them still have different formats. Further information about the XML file itself will be available in the T3D technical documentation once it is reintegrated. |
| | 4 | |
| | 5 | There are currently three types of log messages: |
| | 6 | * Information |
| | 7 | * Warning |
| | 8 | * Error |
| | 9 | |
| | 10 | === Information === |
| | 11 | |
| | 12 | Information messages include general information about the documentation process, its progress, as well as brief statistics at the end. Some of the messages may change to status-type messages in the future, once such type of log messages is introduced to T3D. Currently the following types of information are considered information messages: |
| | 13 | * Status reporting (parsing a file, processing a file) |
| | 14 | * Runtimes of the separate phases of T3D |
| | 15 | * The number of generated HTML documentation files |
| | 16 | * Brief statistics including |
| | 17 | * A list of all processed files |
| | 18 | * A list of all files processed without errors or warnings |
| | 19 | * A list of all files processed with errors or warnings |
| | 20 | |
| | 21 | Not all of these messages are explicitly marked as ''INFORMATION'' messages as of yet, but this will be a subject to change in the future, where the log output format will be uniform for all log messages. |
| | 22 | |
| | 23 | [[Include(wiki:Documentation/T3D/Log-Output/Warnings)]] |
| | 24 | |
| | 25 | === Error === |
| | 26 | |
| | 27 | Error messages are produced on unrecoverable errors, such as a parsing error (although there is an option in the configuration that would allow bypassing parsing errors, but it is disabled by default and it is recommended that it stays that way for reliable results). |
