[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH-for-6.2? 2/3] docs/devel/style: Improve Error** functions rST ren
[PATCH-for-6.2? 2/3] docs/devel/style: Improve Error** functions rST rendering
Tue, 16 Nov 2021 16:13:16 +0100
Signed-off-by: Philippe Mathieu-Daudé <firstname.lastname@example.org>
docs/devel/style.rst | 30 +++++++++++++++---------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/docs/devel/style.rst b/docs/devel/style.rst
index 415a6b9d700..21f0f213193 100644
@@ -602,16 +602,16 @@ Error handling and reporting
Reporting errors to the human user
-Do not use printf(), fprintf() or monitor_printf(). Instead, use
-error_report() or error_vreport() from error-report.h. This ensures the
-error is reported in the right place (current monitor or stderr), and in
-a uniform format.
+Do not use ``printf()``, ``fprintf()`` or ``monitor_printf()``. Instead, use
+``error_report()`` or ``error_vreport()`` from error-report.h. This ensures
+the error is reported in the right place (current monitor or ``stderr``), and
+in a uniform format.
-Use error_printf() & friends to print additional information.
+Use ``error_printf()`` & friends to print additional information.
-error_report() prints the current location. In certain common cases
+``error_report()`` prints the current location. In certain common cases
like command line parsing, the current location is tracked
-automatically. To manipulate it manually, use the loc_``*``() from
+automatically. To manipulate it manually, use the ``loc_*()`` from
@@ -621,7 +621,7 @@ An error can't always be reported to the user right where
but often needs to be propagated up the call chain to a place that can
handle it. This can be done in various ways.
-The most flexible one is Error objects. See error.h for usage
+The most flexible one is ``Error`` objects. See error.h for usage
Use the simplest suitable method to communicate success / failure to
@@ -631,10 +631,10 @@ error, non-negative / -errno, non-null / null, or Error
Example: when a function returns a non-null pointer on success, and it
can fail only in one way (as far as the caller is concerned), returning
null on failure is just fine, and certainly simpler and a lot easier on
-the eyes than propagating an Error object through an Error ``*````*``
+the eyes than propagating an Error object through an ``Error **`` parameter.
Example: when a function's callers need to report details on failure
-only the function really knows, use Error ``*````*``, and set suitable errors.
+only the function really knows, use ``Error **``, and set suitable errors.
Do not report an error to the user when you're also returning an error
for somebody else to handle. Leave the reporting to the place that
@@ -643,17 +643,17 @@ consumes the error returned.
-Calling exit() is fine when handling configuration errors during
+Calling ``exit()`` is fine when handling configuration errors during
startup. It's problematic during normal operation. In particular,
-monitor commands should never exit().
+monitor commands should never ``exit()``.
-Do not call exit() or abort() to handle an error that can be triggered
+Do not call ``exit()`` or ``abort()`` to handle an error that can be triggered
by the guest (e.g., some unimplemented corner case in guest code
translation or device emulation). Guests should not be able to
-Note that &error_fatal is just another way to exit(1), and &error_abort
-is just another way to abort().
+Note that ``&error_fatal`` is just another way to ``exit(1)``, and
+``&error_abort`` is just another way to ``abort()``.