man: document fido_cred_append_type

Yubico · Nov 15, 2024 · f7e8e8f · f7e8e8f
1 parent 511f4c0
commit f7e8e8f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
@@ -211,8 +211,9 @@ list(APPEND MAN_ALIAS
 	fido_credman_metadata_new fido_credman_rp_name
 	fido_credman_metadata_new fido_credman_rp_new
 	fido_credman_metadata_new fido_credman_set_dev_rk
-	fido_cred_set_authdata fido_cred_set_attstmt
+	fido_cred_set_authdata fido_cred_append_type
 	fido_cred_set_authdata fido_cred_set_attobj
+	fido_cred_set_authdata fido_cred_set_attstmt
 	fido_cred_set_authdata fido_cred_set_authdata_raw
 	fido_cred_set_authdata fido_cred_set_blob
 	fido_cred_set_authdata fido_cred_set_clientdata

diff --git a/man/fido_cred_set_authdata.3 b/man/fido_cred_set_authdata.3
@@ -99,6 +99,8 @@ typedef enum {
 .Fn fido_cred_set_fmt "fido_cred_t *cred" "const char *ptr"
 .Ft int
 .Fn fido_cred_set_type "fido_cred_t *cred" "int cose_alg"
+.Ft int
+.Fn fido_cred_append_type "fido_cred_t *cred" "int cose_alg"
 .Sh DESCRIPTION
 The
 .Nm
@@ -392,6 +394,13 @@ The type of a credential may only be set once.
 Note that not all authenticators support COSE_RS256, COSE_ES384, or
 COSE_EDDSA.
 .Pp
+The
+.Fn fido_cred_append_type
+function is the same as
+.Fn fido_cred_set_type
+but can be called repeatedly to request one of multiple types, in order
+of preference.
+.Pp
 Use of the
 .Nm
 set of functions may happen in two distinct situations: