vim-patch:8.2.3825: various comments could be improved

Problem:    Various comments could be improved.
Solution:   Improve the comments.
52797bae17
This commit is contained in:
zeertzjq
2021-12-16 23:05:52 +08:00
parent 56fa08b458
commit f59f81c32e
4 changed files with 24 additions and 23 deletions

View File

@@ -18,22 +18,20 @@
#include "nvim/garray.h"
#include "nvim/os/input.h"
/*
* Logging of NFA engine.
*
* The NFA engine can write four log files:
* - Error log: Contains NFA engine's fatal errors.
* - Dump log: Contains compiled NFA state machine's information.
* - Run log: Contains information of matching procedure.
* - Debug log: Contains detailed information of matching procedure. Can be
* disabled by undefining NFA_REGEXP_DEBUG_LOG.
* The first one can also be used without debug mode.
* The last three are enabled when compiled as debug mode and individually
* disabled by commenting them out.
* The log files can get quite big!
* Do disable all of this when compiling Vim for debugging, undefine REGEXP_DEBUG in
* regexp.c
*/
// Logging of NFA engine.
//
// The NFA engine can write four log files:
// - Error log: Contains NFA engine's fatal errors.
// - Dump log: Contains compiled NFA state machine's information.
// - Run log: Contains information of matching procedure.
// - Debug log: Contains detailed information of matching procedure. Can be
// disabled by undefining NFA_REGEXP_DEBUG_LOG.
// The first one can also be used without debug mode.
// The last three are enabled when compiled as debug mode and individually
// disabled by commenting them out.
// The log files can get quite big!
// To disable all of this when compiling Vim for debugging, undefine REGEXP_DEBUG in
// regexp.c
#ifdef REGEXP_DEBUG
# define NFA_REGEXP_ERROR_LOG "nfa_regexp_error.log"
# define NFA_REGEXP_DUMP_LOG "nfa_regexp_dump.log"