Content-Type: multipart/mixed; boundary="------------EHXopKzu0GRt8ygqK07vmjTz"
Message-ID: <ac858943-4743-44cd-b4ad-08a0c10cbbc8@gmail.com>
Date: Mon, 9 Dec 2024 20:39:03 -0300
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Content-Language: en-US
From: Matheus Alcantara <matheusssilv97@gmail.com>
To: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Subject: Outdated comment on scram_build_secret
Archived-At: 
 <https://www.postgresql.org/message-id/ac858943-4743-44cd-b4ad-08a0c10cbbc8%40gmail.com>
Precedence: bulk

This is a multi-part message in MIME format.
--------------EHXopKzu0GRt8ygqK07vmjTz
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

Hi,

The documentation for the iterations parameter on scram_build_secret say:
  * If iterations is 0, default number of iterations is used.

But the body of the function have the following assert
	Assert(iterations > 0);

Commit b577743000 introduced the assert and remove the if condition. 
All usages of this function is using an iteration > 0, so I think that 
is just a matter of updating the documentation? If that's the case the 
attached patch does that.

-- 
Matheus Alcantara
EDB: https://www.enterprisedb.com

--------------EHXopKzu0GRt8ygqK07vmjTz
Content-Type: text/plain; charset=UTF-8;
 name="v1-0001-Fix-outdated-scram_build_secret-comment.patch"
Content-Disposition: attachment;
 filename="v1-0001-Fix-outdated-scram_build_secret-comment.patch"
Content-Transfer-Encoding: base64

RnJvbSBjNTYwZTBjNWI3ZTUxZTQ4MzE0YzZlM2FkYTYxMjZmOWVmMjdkOGUzIE1vbiBTZXAg
MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBNYXRoZXVzIEFsY2FudGFyYSA8bXRocy5kZXZAcG0u
bWU+CkRhdGU6IE1vbiwgOSBEZWMgMjAyNCAyMDozNjozMCAtMDMwMApTdWJqZWN0OiBbUEFU
Q0ggdjFdIEZpeCBvdXRkYXRlZCBzY3JhbV9idWlsZF9zZWNyZXQgY29tbWVudAoKLS0tCiBz
cmMvY29tbW9uL3NjcmFtLWNvbW1vbi5jIHwgMyArLS0KIDEgZmlsZSBjaGFuZ2VkLCAxIGlu
c2VydGlvbigrKSwgMiBkZWxldGlvbnMoLSkKCmRpZmYgLS1naXQgYS9zcmMvY29tbW9uL3Nj
cmFtLWNvbW1vbi5jIGIvc3JjL2NvbW1vbi9zY3JhbS1jb21tb24uYwppbmRleCBiNjExYmI4
ZmU3Li41MWNjMTJlOGMzIDEwMDY0NAotLS0gYS9zcmMvY29tbW9uL3NjcmFtLWNvbW1vbi5j
CisrKyBiL3NyYy9jb21tb24vc2NyYW0tY29tbW9uLmMKQEAgLTIwMCw4ICsyMDAsNyBAQCBz
Y3JhbV9TZXJ2ZXJLZXkoY29uc3QgdWludDggKnNhbHRlZF9wYXNzd29yZCwKICAqCiAgKiBU
aGUgcGFzc3dvcmQgc2hvdWxkIGFscmVhZHkgaGF2ZSBiZWVuIHByb2Nlc3NlZCB3aXRoIFNB
U0xwcmVwLCBpZiBuZWNlc3NhcnkhCiAgKgotICogSWYgaXRlcmF0aW9ucyBpcyAwLCBkZWZh
dWx0IG51bWJlciBvZiBpdGVyYXRpb25zIGlzIHVzZWQuICBUaGUgcmVzdWx0IGlzCi0gKiBw
YWxsb2MnZCBvciBtYWxsb2MnZCwgc28gY2FsbGVyIGlzIHJlc3BvbnNpYmxlIGZvciBmcmVl
aW5nIGl0LgorICogVGhlIHJlc3VsdCBpcyBwYWxsb2MnZCBvciBtYWxsb2MnZCwgc28gY2Fs
bGVyIGlzIHJlc3BvbnNpYmxlIGZvciBmcmVlaW5nIGl0LgogICoKICAqIE9uIGVycm9yLCBy
ZXR1cm5zIE5VTEwgYW5kIHNldHMgKmVycnN0ciB0byBwb2ludCB0byBhIG1lc3NhZ2UgYWJv
dXQgdGhlCiAgKiBlcnJvciBkZXRhaWxzLgotLSAKMi4zOS4zIChBcHBsZSBHaXQtMTQ2KQoK


--------------EHXopKzu0GRt8ygqK07vmjTz--