From: Daniel Gustafsson <dgustafsson@postgresql.org>
Date: Thu, 14 Mar 2024 08:23:37 +0000 (+0100)
Subject: Fix documentation comment for pg_md5_hash
X-Git-Tag: REL_17_BETA1~644
X-Git-Url: http://git.postgresql.org/gitweb/?a=commitdiff_plain;h=6b41ef03306f50602f68593d562cd73d5e39a9b9;p=postgresql.git

Fix documentation comment for pg_md5_hash

Commit b69aba74578 added the errstr parameter to pg_md5_hash but
missed updating the synopsis in the documentation comment.  The
follow-up commit 587de223f03 added the parameter to the list of
outputs.  The returnvalue had been changed from integer to bool
before that but remained in the synopsis.  This fixes both.

Author: Tatsuro Yamada <tatsuro.yamada@ntt.com>
Discussion: https://postgr.es/m/TYYPR01MB82313576150CC86084A122CD9E292@TYYPR01MB8231.jpnprd01.prod.outlook.com
---

diff --git a/src/common/md5_common.c b/src/common/md5_common.c
index 094878479cf..c654efe9718 100644
--- a/src/common/md5_common.c
+++ b/src/common/md5_common.c
@@ -45,7 +45,8 @@ bytesToHex(uint8 b[16], char *s)
  *	Calculates the MD5 sum of the bytes in a buffer.
  *
  *	SYNOPSIS	  #include "md5.h"
- *				  int pg_md5_hash(const void *buff, size_t len, char *hexsum)
+ *				  bool pg_md5_hash(const void *buff, size_t len, char *hexsum,
+ *				                   const char **errstr)
  *
  *	INPUT		  buff	  the buffer containing the bytes that you want
  *						  the MD5 sum of.