Commit 642059d1 authored by Geoff Simmons's avatar Geoff Simmons

fix the comments for base64_encode()

parent b1e14829
......@@ -80,17 +80,15 @@ event(VRT_CTX, struct vmod_priv *priv, enum vcl_event_e event)
}
/*
* Base64-encode *in (size: inlen) into *out, max outlen bytes. If there is
* insufficient space, it will bail out and return -1. Otherwise, it will
* null-terminate and return the used space.
* The alphabet `a` defines... the alphabet. Padding is optional.
* Base64-encode *in (size: inlen) into the blob supplied as rblob. If
* there is insufficient space, it will bail out and return
* NULL. Otherwise, it will null-terminate and return the blob.
* The enc argument specifies the alphabet and whether padding is used.
* Inspired heavily by gnulib/Simon Josefsson (as referenced in RFC4648)
*
* XXX: tmp[] and idx are used to ensure the reader (and author) retains
* XXX: a limited amount of sanity. They are strictly speaking not
* XXX: necessary, if you don't mind going crazy.
*
* FIXME: outlenorig is silly. Flip the logic.
*/
static VCL_BLOB
base64_encode (struct ws *ws, const enum encoding enc, struct vmod_priv *rblob,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment