gnutls_psk_set_server_credentials_file: document the file format

Signed-off-by: Daiki Ueno <ueno@gnu.org>

diff --git a/lib/psk.c b/lib/psk.c
index 6ea3adb63c44f656582a2ef9a836f4d47891b41f..e5f2b05311ad3ed946ec37db112c3ee1a39c89d6 100644 (file)
--- a/lib/psk.c
+++ b/lib/psk.c
@@ -231,6 +231,11 @@ gnutls_psk_allocate_server_credentials(gnutls_psk_server_credentials_t *
  * #gnutls_psk_server_credentials_t type.  This password file
  * holds usernames and keys and will be used for PSK authentication.
  *
+ * Each entry in the file consists of a username, followed by a colon
+ * (':') and a hex-encoded key.  If the username contains a colon or
+ * any other special character, it can be hex-encoded preceded by a
+ * '#'.
+ *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
  **/