# HG changeset patch
# User Sietse Brouwer <sbbrouwer@gmail.com>
# Date 1556890628 -7200
# Node ID 037a97d62625e4e81f7ba31dafaa12138b5e505e
# Parent  3816e361e3d82830181644ffb9de400e50a41c38
gendoc: guarantee that all commands were processed

The new logic renders the commands belonging to each category in turn.
Commands with an unregistered category are at risk of getting skipped
because their category is not in the list. By comparing the list of all
commands to a log of processed commands, we can detect commands with
unregistered categories and fail with an error message.

Differential Revision: https://phab.mercurial-scm.org/D6327

diff -r 3816e361e3d8 -r 037a97d62625 doc/gendoc.py
--- a/doc/gendoc.py	Fri Apr 26 17:53:01 2019 +0200
+++ b/doc/gendoc.py	Fri May 03 15:37:08 2019 +0200
@@ -194,13 +194,19 @@
         helpcategory = details[0].helpcategory
         return helpcategory or help.registrar.command.CATEGORY_NONE
 
+    cmdsbycategory = {category: [] for category in help.CATEGORY_ORDER}
+    for cmd in cmds:
+        # If a command category wasn't registered, the command won't get
+        # rendered below, so we raise an AssertionError.
+        if helpcategory(cmd) not in cmdsbycategory:
+            raise AssertionError(
+                "The following command did not register its (category) in "
+                "help.CATEGORY_ORDER: %s (%s)" % (cmd, helpcategory(cmd)))
+        cmdsbycategory[helpcategory(cmd)].append(cmd)
+
     # Print the help for each command. We present the commands grouped by
     # category, and we use help.CATEGORY_ORDER as a guide for a helpful order
     # in which to present the categories.
-    cmdsbycategory = {category: [] for category in help.CATEGORY_ORDER}
-    for cmd in cmds:
-        cmdsbycategory[helpcategory(cmd)].append(cmd)
-
     for category in help.CATEGORY_ORDER:
         categorycmds = cmdsbycategory[category]
         if not categorycmds:
@@ -250,7 +256,6 @@
             if d[b'aliases']:
                 ui.write(_(b"    aliases: %s\n\n") % b" ".join(d[b'aliases']))
 
-
 def allextensionnames():
     return set(extensions.enabled().keys()) | set(extensions.disabled().keys())