From 72e04bd13f22a14c29f2cfe8f432875641b3e772 Mon Sep 17 00:00:00 2001 From: "Dr. Stephen Henson" Date: Sun, 6 Oct 2002 12:59:25 +0000 Subject: [PATCH 1/1] Document "0" and "1" naming convention. --- doc/crypto/crypto.pod | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/crypto/crypto.pod b/doc/crypto/crypto.pod index c12eec1409..7a527992bb 100644 --- a/doc/crypto/crypto.pod +++ b/doc/crypto/crypto.pod @@ -62,6 +62,22 @@ L =back +=head1 NOTES + +Some of the newer functions follow a naming convention using the numbers +B<0> and B<1>. For example the functions: + + int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev); + int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj); + +The B<0> version uses the supplied structure pointer directly +in the parent and it will be freed up when the parent is freed. +In the above example B would be freed but B would not. + +The B<1> function uses a copy of the supplied structure pointer +(or in some cases increases its link count) in the parent and +so both (B and B above) should be freed up. + =head1 SEE ALSO L, L -- 2.34.1