summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING10
1 files changed, 5 insertions, 5 deletions
diff --git a/HACKING b/HACKING
index b9f96d63..d28cbc48 100644
--- a/HACKING
+++ b/HACKING
@@ -95,17 +95,17 @@ Igor Zlatkovic get an exception for the send before commit rule.
- Errors reporting (XMLSEC_ERRORS_R_XMLSEC_FAILED vs. XMLSEC_ERRORS_R_CRYPTO_FAILED)
The correct usage rule is:
if the failed function starts with "xmlSec" then use
- XMLSEC_ERRORS_R_XMLSEC_FAILED
- else if it is xmlMalloc/xmlFree/xmlStrdup/etc then use
- XMLSEC_ERRORS_R_MALLOC_FAILED
+ xmlSecInternalError() aka XMLSEC_ERRORS_R_XMLSEC_FAILED
+ else if it is xmlMalloc/xmlFree/etc then use
+ xmlSecMallocError() aka XMLSEC_ERRORS_R_MALLOC_FAILED
else if the function starts with "xml" or "xslt" (i.e. it comes
from libxml or libxslt) then use
- XMLSEC_ERRORS_R_XML_FAILED
+ xmlSecXmlError/xmlSecXmlParserError aka XMLSEC_ERRORS_R_XML_FAILED
else if it is related to IO (fopen, fread, fwrite, etc.) then use
XMLSEC_ERRORS_R_IO_FAILED
else if the function could be used only from xmlsec-crypto (i.e.
it is crypto engine related) then use
- XMLSEC_ERRORS_R_CRYPTO_FAILED
+ xmlSecOpenSSLError/... aka XMLSEC_ERRORS_R_CRYPTO_FAILED
else if there is another reason (invalid data, invalid size, etc.)
corresponding error reason should be used
else