]> git.ozlabs.org Git - ccan/blobdiff - ccan/rfc822/rfc822.h
base64: fix for unsigned chars (e.g. ARM).
[ccan] / ccan / rfc822 / rfc822.h
index 24fb3cc37e74e2b58a8a0a1f4d00225708fe9d95..a4ac156522ebdfbffb3401b39ee8567f63ecaa51 100644 (file)
@@ -22,6 +22,9 @@ struct rfc822_msg;
  * callback is called with a string describing where the failure
  * occurred, which can be used to log a more useful error message.
  *
+ * Note that tal also has a default function which calls abort() on allocation
+ * failure: see tal_set_backend().
+ *
  * Example:
  *     static void my_handler(const char *str)
  *     {
@@ -53,15 +56,15 @@ static inline bool rfc822_iswsp(char c)
  * inconsistent, and the function will abort.  If the state of the
  * structure is valid it returns it unchanged.
  *
- * Returns the list head if the list is consistent, NULL if not (it
- * can never return NULL if @abortstr is set).
+ * Returns the @msg if the message is consistent, NULL if not (it can
+ * never return NULL if @abortstr is set).
  */
 struct rfc822_msg *rfc822_check(const struct rfc822_msg *msg,
                                const char *abortstr);
 
 /**
  * rfc822_start - start parsing a new rfc822 message
- * @ctx: talloc context to make allocations in
+ * @ctx: tal context to make allocations in (or talloc #ifdef TAL_USE_TALLOC)
  * @p: pointer to a buffer containing the message text
  * @len: length of the message text
  *
@@ -75,7 +78,7 @@ struct rfc822_msg *rfc822_start(const void *ctx, const char *p, size_t len);
  * rfc822_free - free an rfc822 message
  * @msg: message to free
  *
- * Frees an rfc822_msg context, including all subsiduary data
+ * Frees an rfc822_msg context, including all subsidiary data
  * structures.
  */
 void rfc822_free(struct rfc822_msg *msg);