Tcl Library Source Code

View Ticket
Login
Ticket UUID: 83567329c96e234dce429b97c3c0828285d2f7f3
Title: suggest clarification of pki docs about proc input types
Type: RFE Version: 0.6
Submitter: anonymous Created on: 2016-03-19 09:01:13
Subsystem: pki Assigned To: rkeene
Priority: 3 Low Severity: Cosmetic
Status: Open Last Modified: 2016-03-23 04:58:26
Resolution: None Closed By: nobody
    Closed on:
Description:
Re: the man page for the pki module; coming from using openssl, I assumed that the input for procs such as ::pki::x509::parse_cert, when calling for "cert", referred to a certificate file name.  After getting errors and looking more closely at the code, I realized that "cert" was expected to be a variable containing the actual binary or base64-encoded data.

This is not technically incorrect since the cert is the data and not the file created by (e.g.) openssl to contain it.  But I think it would be helpful to first-time users if the docs used phrases like "binary or base64-encoded contents of a certificate", rather than  simply "certificate".

Attachments: