summary refs log tree commit diff stats
path: root/include/qapi/error.h
diff options
context:
space:
mode:
authorZhao Liu <zhao1.liu@intel.com>2024-03-11 11:37:54 +0800
committerThomas Huth <thuth@redhat.com>2024-03-12 11:45:33 +0100
commit042e4942b926eb067cbc040d7c7fa87a7ebc0917 (patch)
tree97db5453970a713521ae0645e7be841421e52404 /include/qapi/error.h
parent4a9fafb478b5d9e6977d0c422f25062550ebce3a (diff)
downloadfocaccia-qemu-042e4942b926eb067cbc040d7c7fa87a7ebc0917.tar.gz
focaccia-qemu-042e4942b926eb067cbc040d7c7fa87a7ebc0917.zip
error: Add error_vprepend() in comment of ERRP_GUARD() rules
The error_vprepend() should use ERRP_GUARD() just as the documentation
of ERRP_GUARD() says:

> It must be used when the function dereferences @errp or passes
> @errp to error_prepend(), error_vprepend(), or error_append_hint().

Considering that error_vprepend() is also an API provided in error.h,
it is necessary to add it to the description of the rules for using
ERRP_GUARD().

Cc: Markus Armbruster <armbru@redhat.com>
Cc: Michael Roth <michael.roth@amd.com>
Signed-off-by: Zhao Liu <zhao1.liu@intel.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240311033822.3142585-2-zhao1.liu@linux.intel.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
Diffstat (limited to 'include/qapi/error.h')
-rw-r--r--include/qapi/error.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/qapi/error.h b/include/qapi/error.h
index f21a231bb1..71f8fb2c50 100644
--- a/include/qapi/error.h
+++ b/include/qapi/error.h
@@ -207,7 +207,7 @@
  *
  * Without ERRP_GUARD(), use of the @errp parameter is restricted:
  * - It must not be dereferenced, because it may be null.
- * - It should not be passed to error_prepend() or
+ * - It should not be passed to error_prepend(), error_vprepend(), or
  *   error_append_hint(), because that doesn't work with &error_fatal.
  * ERRP_GUARD() lifts these restrictions.
  *