Closed Bug 905387 Opened 9 years ago Closed 9 years ago

Typo in documentation of SGN_Digest

Categories

(NSS :: Documentation, defect, P5)

Product:
NSS
Component:
Documentation
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED FIXED
Milestone:
3.15.2

People

(Reporter: eroman, Assigned: ryan.sleevi)

Details

Attachments

(1 file)

Comment fix
927 bytes, patch
wtc
: review+
ryan.sleevi
: checked-in+
Details | Diff | Splinter Review 
User Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/28.0.1500.95 Safari/537.36

Steps to reproduce:

http://mxr.mozilla.org/nss/source/lib/cryptohi/cryptohi.h#118

110 /*
111 ** Sign a pre-digested block of data using private key encryption, encoding
112 **  The given signature/hash algorithm.
113 **	"result" the final signature data (memory is allocated)
114 **	"digest" the digest to sign
115 **	"pk" the private key to encrypt with
116 **	"algtag" The algorithm tag to encode (need for RSA only)
117 */
118 extern SECStatus SGN_Digest(SECKEYPrivateKey *privKey,
119                 SECOidTag algtag, SECItem *result, SECItem *digest);

The comment speaks of "pk" however the function signature names the parameter "privKey"
Attached patch Comment fix — — Splinter Review
Assignee: nobody → ryan.sleevi
Status: UNCONFIRMED → ASSIGNED
Ever confirmed: true
Attachment #790455 - Flags: review?(wtc)
Attachment #790455 - Flags: checked-in+
Committed as https://hg.mozilla.org/projects/nss/rev/989ed60c203e
Status: ASSIGNED → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Priority: -- → P5
Target Milestone: --- → 3.15.2
Comment on attachment 790455 [details] [diff] [review]
Comment fix

Review of attachment 790455 [details] [diff] [review]:
-----------------------------------------------------------------

r=wtc.
Attachment #790455 - Flags: review?(wtc) → review+
You need to log in before you can comment on or make changes to this bug.