932001 - certutil is missing the description of the --email option

Status: RESOLVED FIXED

(NSS :: Documentation, defect, P2)

Description

[Elio Maldonado]

Attachment: document certutil's --email option

Comment 1

[Elio Maldonado]

Running certutil -L --help
-L              List all certs, or print out a single named cert
   -n cert-name      Pretty print named cert (list all if unspecified)
   --email email-address 
                     Pretty print cert with email address (list all if unspecified)
   -d certdir        Cert database directory (default is ~/.netscape)
   -P dbprefix       Cert & Key database prefix
   -X                force the database to open R/W
   -r                For single cert, print binary DER encoding
   -a                For single cert, print ASCII encoding (RFC1113)

Comment 2

[Kai Engert (:KaiE:)]

May I suggest a different wording, to make the purpose of the option more obvious?

The purpose wasn't immediately obvious to me. It's clear why you say "named certificate", since the email address is used for selecting the certificate. Since --email is an alternative for using the -n option, I propose a similar wording, based on the current wording for -n.

Proposed wording:
"Specify the email address of a certificate to list. Used with the -L command option."

Comment 3

[Elio Maldonado]

(In reply to Kai Engert (:kaie) from comment #2)
> Proposed wording:
> "Specify the email address of a certificate to list. Used with the -L command option."
Thank you, that's a lot clearer.

Comment 4

[Elio Maldonado]

Using a comma makes the title one sentence, a nitpick.

Comment 5

[Kai Engert (:KaiE:)]

Elio, my comment wasn't intended for the bug summary.

My suggestion is a proposal for a better wording for the contents in the manpage and in the patch!

Comment 6

[Elio Maldonado]

Attachment: V2 - with Kai's clearer wording

Comment 7

[Kai Engert (:KaiE:)]

Comment on attachment 824923 [details] [diff] [review]
V2 - with Kai's clearer wording

Thanks!
r=kaie

Comment 8

[Elio Maldonado]

Changes pushed to git https://hg.mozilla.org/projects/nss/rev/ad9713714ffe

Comment 9

[Elio Maldonado]

s/git/mercurial/

Comment 10

[Kai Engert (:KaiE:)]

You did not update the pre-built html/man-page documentation at the time of checkin.

This has been fixed with the checkin for bug 933688
https://hg.mozilla.org/projects/nss/rev/0560a4f7312a

Comment 11

[Elio Maldonado]

I forgot that part, will do it right now.

Comment 12

[Elio Maldonado]

Pushed the updates man pages and html pages
https://hg.mozilla.org/projects/nss/rev/4e3d88c7ffc3

Comment 13

[Kai Engert (:KaiE:)]

Elio, I said I already fixed it.

Comment 14

[Kai Engert (:KaiE:)]

changing target milestone to 3.15.4