From 136f1c470665a9328bb4120f3a4d9af774dadb2d Mon Sep 17 00:00:00 2001
From: Samuel Dionne-Riel <samuel@dionne-riel.com>
Date: Wed, 16 May 2018 12:11:36 -0400
Subject: [PATCH] doc: Fixes documented default option for `<name>` for
 submodules. (#40464)

Fixes #40463

This is related to change 1d56d0c8a79334cd7149fd580512046558eaac78
---
 lib/types.nix | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lib/types.nix b/lib/types.nix
index 772716897725..5aa09d33e9b3 100644
--- a/lib/types.nix
+++ b/lib/types.nix
@@ -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;