docs/devel: Fix formatting of `Error **`
Since the ReST conversion, Error ** is expressed as Error ``*````*``, which is rendered in HTML as Error *````*. Fix it so the HTML output resembles the intended C syntax. Fixes: 336a7451e8 ("docs: convert README, CODING_STYLE and HACKING to RST syntax") Signed-off-by: J. Neuschäfer <j.neuschaefer@9elements.com> Tested-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com> Reviewed-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com> Link: https://lore.kernel.org/qemu-devel/20260513-error-v1-1-49fa04bc5c22@9elements.com Signed-off-by: Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>
J. Neuschäfer committed
May 13, 2026 at 17:06 UTC
785724e81c35bb5bb13400d8424e26671a0fd74f
1 file changed
+2
-2
docs/devel/style.rst
+2
-2
@@ -784,10 +784,10 @@ error, non-negative / -errno, non-null / null, or Error objects.
784
Example: when a function returns a non-null pointer on success, and it
785
can fail only in one way (as far as the caller is concerned), returning
786
null on failure is just fine, and certainly simpler and a lot easier on
787
-the eyes than propagating an Error object through an Error ``*````*`` parameter.
787
+the eyes than propagating an Error object through an ``Error **`` parameter.
788
789
Example: when a function's callers need to report details on failure
790
-only the function really knows, use Error ``*````*``, and set suitable errors.
790
+only the function really knows, use ``Error **``, and set suitable errors.
791
792
Do not report an error to the user when you're also returning an error
793
for somebody else to handle. Leave the reporting to the place that