Add comment for bug 243585

security/nss/lib/certdb/cert.h

@@ -37,7 +37,7 @@
 /*
  * cert.h - public data structures and prototypes for the certificate library
  *
- * $Id: cert.h,v 1.49 2005/02/15 06:26:42 julien.pierre.bugs%sun.com Exp $
+ * $Id: cert.h,v 1.50 2005/02/24 00:22:23 julien.pierre.bugs%sun.com Exp $
  */
 
 #ifndef _CERT_H_
@@ -453,10 +453,13 @@ extern void CERT_DestroyCrl (CERTSignedCrl *crl);
    the issuer (CA). */
 void CERT_CRLCacheRefreshIssuer(CERTCertDBHandle* dbhandle, SECItem* crlKey);
 
-/* add the specified RAM CRL object to the cache.
-   Once a CRL is added to the cache, the application must hold on to the
-   memory, because the cache will  reference it directly. It can only
-   free it after it calls CERT_UncacheCRL .
+/* add the specified RAM CRL object to the CRL cache. Doing so will allow
+   certificate verification functions (such as CERT_VerifyCertificate)
+   to automatically find and make use of this CRL object.
+   Once a CRL is added to the CRL cache, the application must hold on to
+   the object's memory, because the cache will reference it directly. The
+   application can only free the object after it calls CERT_UncacheCRL to
+   remove it from the CRL cache.
 */
 SECStatus CERT_CacheCRL(CERTCertDBHandle* dbhandle, SECItem* newcrl);