Maintenance tools - Revision history

Pentarctagon: /* wmllint */

2026-07-03T16:36:50Z

‎wmllint

Pentarctagon: /* wmllint */

2026-07-03T16:36:21Z

‎wmllint

Pentarctagon: /* wmllint */

2026-07-03T16:34:10Z

‎wmllint

Pentarctagon: /* wmllint */

2026-07-03T16:33:25Z

‎wmllint

Bssarkar: /* wmllint */ Explain no-icon flag based on code

2026-03-24T11:14:32Z

‎wmllint: Explain no-icon flag based on code

Egallager: /* wmllint */ wiki version of https://github.com/wesnoth/wesnoth/commit/2583d9ae80e26b433e04a74a78d83e72098a11b0

2024-12-31T23:47:25Z

‎wmllint: wiki version of https://github.com/wesnoth/wesnoth/commit/2583d9ae80e26b433e04a74a78d83e72098a11b0

Egallager: /* wmlscope */ Update with info from the big block comment at the top of the script

2024-08-17T23:19:50Z

‎wmlscope: Update with info from the big block comment at the top of the script

Egallager: /* wmllint */ additional note about spellchecking

2023-12-30T09:01:41Z

‎wmllint: additional note about spellchecking

Egallager: /* wmllint */ sync with current `wmllint --help` output, and update info about spellchecking

2023-12-30T08:54:56Z

‎wmllint: sync with current `wmllint --help` output, and update info about spellchecking

Egallager: add "See Also" section

2023-05-08T02:48:03Z

add "See Also" section

@@ Line 374: / Line 374: @@
 # Use either --clean to remove the -bak files or --revert to undo the conversion.
-wmllint supports a number of magic comments to customize its behaviour and avoid false positives. Almost all magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. These are all documented at the top of the wmllint tool itself: https://github.com/wesnoth/wesnoth/blob/master/data/tools/wmllint
+wmllint supports a number of magic comments to customize its behaviour and avoid false positives. Almost all magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. These are all documented at the top of the wmllint tool itself in the MAGIC COMMENTS section: https://github.com/wesnoth/wesnoth/blob/master/data/tools/wmllint
 === Explanations of <tt>wmllint</tt> diagnostics ===

@@ Line 374: / Line 374: @@
 # Use either --clean to remove the -bak files or --revert to undo the conversion.
-wmllint supports a number of magic comments to customize its behaviour and avoid false positives. All magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. In the below explanations, a string of the form <code>[a|b]</code> means you may use either <code>a</code> or <code>b</code> at that location, while a string of the form <code><arg></code> indicates free text substitution.
+wmllint supports a number of magic comments to customize its behaviour and avoid false positives. Almost all magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. These are all documented at the top of the wmllint tool itself: https://github.com/wesnoth/wesnoth/blob/master/data/tools/wmllint
 === Explanations of <tt>wmllint</tt> diagnostics ===

@@ Line 355: / Line 355: @@
 ; -v, --verbose:              Set verbosity; more details below.
 ; -K, --known:                Suppress check for unknown unit types, recruits, races, scenarios, etc.
 ; --version:                  show program's version number and exit
 ; --config:                   allows specifying directories to include ('''include_dirs'''), directories to exclude ('''ignore_directories'''), and files to exclude ('''ignore_files''').
@@ Line 374: / Line 373: @@
 # Test the conversion.
 # Use either --clean to remove the -bak files or --revert to undo the conversion.
 wmllint supports a number of magic comments to customize its behaviour and avoid false positives. All magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. In the below explanations, a string of the form <code>[a|b]</code> means you may use either <code>a</code> or <code>b</code> at that location, while a string of the form <code><arg></code> indicates free text substitution.

@@ Line 357: / Line 357: @@
 ; -S, --nospellcheck:         Suppress spellchecking
 ; --version:                  show program's version number and exit
 The verbosity option works like this:

@@ Line 381: / Line 381: @@
 * <code>noconvert</code>: Disables conversion of terrains and image/sound filenames on the current line only.
 * <code>markcheck [on|off]</code>: Enables or disables translation mark checking from the current (next?) line onward.
-* <code>no-icon</code>: Prevents description insertions (what does that mean?)
+* <code>no-icon</code>: If an attack has no description, without this wmllint adds a dummy description to the attack which is just the name of the attack. With this, this description insertion is suppressed.
 * <code>recognize <name></code>: Indicates that the character with the given name exists even though a declaration (ie a <code>[unit]</code> or <code>[side]</code> tag) is not visible.
 * <code>whofield <macro> <number></code>: Indicates that the specified macro declares a character whose name is given by the specified argument to the macro.

@@ Line 351: / Line 351: @@
 ; -d, --dryrun:               List changes (-v) but don't perform them.
 ; -r, --revert:               Revert the conversion from the -bak files.
-; -m, --missing:              Don't warn about tags without side= keys now applying to all sides.
+; -m, --missing:              Warn about tags without side= keys now applying to all sides.
 ; -s, --stripcr:              Convert DOS-style CR/LF to Unix-style LF.
 ; -v, --verbose:              Set verbosity; more details below.

@@ Line 55: / Line 55: @@
 == wmlscope ==
-The main use for <tt>wmlscope</tt> is to find WML macro references without definitions and references to resource files (sounds and images) that don't exist.  These are difficult to spot from in-game because they usually result in silence or a missing image rather than actual broken game logic.  They may happen because of typos in your WML, or because the name of a macro or the location of a resource file changed between versions of the game.
+The main use for <tt>wmlscope</tt> is to find WML macro references without definitions and references to resource files (sounds and images) that don't exist.  These are difficult to spot from in-game because they usually result in silence or a missing image rather than actual broken game logic (see [https://github.com/wesnoth/wesnoth/issues/5332 issue 5332] for more info).  They may happen because of typos in your WML, or because the name of a macro or the location of a resource file changed between versions of the game.
 <tt>wmlscope</tt> also checks macro invocations for consistency.  It will complain
@@ Line 199: / Line 199: @@
 </table>
-If the actual argument is a macro call {.*}, then it matches any formal  Otherwise, if the formal has an identifiable type, <tt>wmlscope</tt> will complain if the actual literal does not match it.
+If the actual argument is a macro call {.*}, then it matches any formal.  Otherwise, if the formal has an identifiable type, <tt>wmlscope</tt> will complain if the actual literal does not match it.
 The argument type check only works in macro calls that fit on a single line.
@@ Line 215: / Line 215: @@
 ; -h, --help:                 Emit a help message and quit
-; -c, --crossreference:       Report resolved macro references (implies -w 1)
+; -c, --crossreference:       Report resolved macro references (implies <tt>-w 1</tt>)
 ; -C, --collisions:           Report duplicate resource files
 ; -d, --deflist:              Make definition list.  (This one is for campaign server maintainers.)
@@ Line 222: / Line 222: @@
 ; -l, --listfiles:            List files that will be processed
 ; -r <i>ddd</i>, --refcount=<i>ddd</i>:     Report only on macros with references in exactly <i>ddd</i> files.
 ; -u, --unresolved:           Report unresolved macro references
 ; -w, --warnlevel:            Set to 1 to warn of duplicate macro definitions
-; --force-used reg:          Ignore reference count 0 on names matching regexp
+; -p, --progress:             Show progress
 ; --extracthelp:              Extract help from macro definition comments.
 == wmllint ==

@@ Line 277: / Line 277: @@
 # Use either --clean to remove the -bak files or --revert to undo the conversion.
-Additionally, wmllint tries to locate a spell checker on your system and spell-checks storyline and message strings.  It will work automatically with any of [https://github.com/AbiWord/enchant enchant]'s spellchecking backends (including aspell, myspell, ispell, applespell, hunspell, nuspell, and so on, depending on the version of enchant), provided you have the <tt>enchant.py</tt> Python library installed.
+Additionally, wmllint tries to locate a spell checker on your system and spell-checks storyline and message strings.  It will work automatically with any of [https://github.com/AbiWord/enchant enchant]'s spellchecking backends (including aspell, myspell, ispell, applespell, hunspell, nuspell, and so on, depending on the version of enchant), provided you have the <tt>enchant.py</tt> Python library installed. Note that the spellchecking results can vary depending on which backend enchant decides to use.
 wmllint supports a number of magic comments to customize its behaviour and avoid false positives. All magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. In the below explanations, a string of the form <code>[a|b]</code> means you may use either <code>a</code> or <code>b</code> at that location, while a string of the form <code><arg></code> indicates free text substitution.

@@ Line 250: / Line 250: @@
 ; -h, --help:                 Emit a help message and quit.
 ; -c, --clean:                Clean up -bak files.
-; -D, --diff:                 Show diffs between converted and unconverted files.
+; -D, --diffs:                Display diffs between converted and unconverted files.
 ; -r, --revert:               Revert the conversion from the -bak files.
-; -n, --nolift:               Suppress lifting, do sanity checks only
+; -m, --missing:              Don't warn about tags without side= keys now applying to all sides.
 The verbosity option works like this:
@@ Line 273: / Line 277: @@
 # Use either --clean to remove the -bak files or --revert to undo the conversion.
-Additionally, wmllint tries to locate a spell checker on your system and spell-checks storyline and message strings.  It will work automatically with either aspell, myspell, or ispell provided you have the <tt>enchant.py</tt> Python library installed.
+Additionally, wmllint tries to locate a spell checker on your system and spell-checks storyline and message strings.  It will work automatically with any of [https://github.com/AbiWord/enchant enchant]'s spellchecking backends (including aspell, myspell, ispell, applespell, hunspell, nuspell, and so on, depending on the version of enchant), provided you have the <tt>enchant.py</tt> Python library installed.
 wmllint supports a number of magic comments to customize its behaviour and avoid false positives. All magic wmllint comments begin with the string <tt>wmllint:</tt>, followed by some additional keyword and potentially some arguments. In the below explanations, a string of the form <code>[a|b]</code> means you may use either <code>a</code> or <code>b</code> at that location, while a string of the form <code><arg></code> indicates free text substitution.

@@ Line 387: / Line 387: @@
 To start it, just double click on the GUI.pyw file. The interface is pretty much self-explanatory, and allows you to run wmllint, wmlscope, wmlindent and wmlxgettext, modify their options, select an add-on and save the tools' output as a text file.
 [[Category:Create]]
 [[Category:Tools]]