doc: Fixes documented default option for <name> for submodules. (#40464)

Fixes #40463

This is related to change 1d56d0c8a7
This commit is contained in:
Samuel Dionne-Riel 2018-05-16 12:11:36 -04:00 committed by xeji
parent 4fbd5a6583
commit 136f1c4706

View file

@ -372,7 +372,13 @@ rec {
# This is mandatory as some option declaration might use the
# "name" attribute given as argument of the submodule and use it
# as the default of option declarations.
args.name = "&lt;name&gt;";
#
# Using lookalike unicode single angle quotation marks because
# of the docbook transformation the options receive. In all uses
# &gt; and &lt; wouldn't be encoded correctly so the encoded values
# would be used, and use of `<` and `>` would break the XML document.
# It shouldn't cause an issue since this is cosmetic for the manual.
args.name = "name";
}).options;
getSubModules = opts';
substSubModules = m: submodule m;