doc: fix documentation mistakes relating to the syscall resolver functions

Signed-off-by: Paul Moore <pmoore@redhat.com>

diff --git a/doc/man/man3/seccomp_syscall_resolve_name.3 b/doc/man/man3/seccomp_syscall_resolve_name.3
index 0e78b554cda8e249c11fe6a777f0f0caa917099b..9795af4bef94b77397678637e4894682a46e4633 100644 (file)
--- a/doc/man/man3/seccomp_syscall_resolve_name.3
+++ b/doc/man/man3/seccomp_syscall_resolve_name.3
@@ -1,4 +1,4 @@
-.TH "seccomp_syscall_resolve_name" 3 "7 January 2013" "paul@paul-moore.com" "libseccomp Documentation"
+.TH "seccomp_syscall_resolve_name" 3 "11 November 2013" "paul@paul-moore.com" "libseccomp Documentation"
 .\" //////////////////////////////////////////////////////////////////////////
 .SH NAME
 .\" //////////////////////////////////////////////////////////////////////////
@@ -44,8 +44,10 @@ the associated syscall number is returned, with the negative pseudo syscall
 number being returned in cases where the given syscall does not exist for the
 architeture.  The value
 .BR __NR_SCMP_ERROR
-is returned in case of error.  In all cases, the return value is suitable for
-use in any libseccomp API function which requires the syscall number, examples include
+is returned if the syscall does not exist with other negative values returned
+on other error conditions.  In all cases, the return value is suitable for
+use in any libseccomp API function which requires the syscall number, examples
+include
 .BR seccomp_rule_add ()
 and
 .BR seccomp_rule_add_exact ().

diff --git a/include/seccomp.h.in b/include/seccomp.h.in
index e150fbd9aca6d13d98b1a0f96397e85f7463fdee..082c14c68ff7e90b7db1204c3793a35bd5e7f336 100644 (file)
--- a/include/seccomp.h.in
+++ b/include/seccomp.h.in
@@ -353,7 +353,8 @@ char *seccomp_syscall_resolve_num_arch(uint32_t arch_token, int num);
  *
  * Resolve the given syscall name to the syscall number for the given
  * architecture.  Returns the syscall number on success, including negative
- * pseudo syscall numbers (e.g. __PNR_*); returns __NR_SCMP_ERROR on failure.
+ * pseudo syscall numbers (e.g. __PNR_*); returns __NR_SCMP_ERROR if the
+ * syscall does not exist, negative values on other error conditions.
  *
  */
 int seccomp_syscall_resolve_name_arch(uint32_t arch_token, const char *name);
@@ -364,7 +365,8 @@ int seccomp_syscall_resolve_name_arch(uint32_t arch_token, const char *name);
  *
  * Resolve the given syscall name to the syscall number.  Returns the syscall
  * number on success, including negative pseudo syscall numbers (e.g. __PNR_*);
- * returns __NR_SCMP_ERROR on failure.
+ * returns __NR_SCMP_ERROR if the syscall does not exist, negative values on
+ * other error conditions.
  *
  */
 int seccomp_syscall_resolve_name(const char *name);