]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/_ext/ceph_confval: print out option name if it does not render 40974/head
authorKefu Chai <kchai@redhat.com>
Thu, 22 Apr 2021 04:06:26 +0000 (12:06 +0800)
committerKefu Chai <kchai@redhat.com>
Thu, 22 Apr 2021 05:00:43 +0000 (13:00 +0800)
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/_ext/ceph_confval.py

index d8a5cda2be8855422b71751253d2723eef8d5c31..28f97e9975c8fb24fbfd0a3d40becc0abe4d6da9 100644 (file)
@@ -210,7 +210,15 @@ class CephOption(Directive):
         desc = opt.get('fmt_desc') or opt.get('long_desc') or opt.get('desc')
         opt_default = opt.get('default')
         default = self.options.get('default', opt_default)
-        rendered = self.template.render(opt=opt, desc=desc, default=default)
+        try:
+            rendered = self.template.render(opt=opt,
+                                            desc=desc,
+                                            default=default)
+        except Exception as e:
+            message = (f'Unable to render option "{name}": {e}. ',
+                       f'opt={opt}, desc={desc}, default={default}')
+            raise self.error(message)
+
         lineno = self.lineno - self.state_machine.input_offset - 1
         source = self.state_machine.input_lines.source(lineno)
         self.state_machine.insert_input(rendered.split('\n'), source)