Name blob argument for consistency

The other methods/functions name it msg
parent ba136098
......@@ -25,7 +25,7 @@ SYNOPSIS
new xdigest = blobdigest.digest(ENUM hash, BLOB init, ENUM scope)
BOOL xdigest.update(BLOB)
BOOL xdigest.update(BLOB msg)
BLOB xdigest.final()
......@@ -46,7 +46,7 @@ SYNOPSIS
::
new OBJECT = blobdigest.digest(ENUM hash [, BLOB init], ["TASK"|"TOP"])
BOOL <obj>.update(BLOB)
BOOL <obj>.update(BLOB msg)
BLOB <obj>.final()
BLOB blobdigest.hash(ENUM hash, BLOB msg)
......@@ -266,11 +266,11 @@ Example::
.. _xdigest.update():
BOOL xdigest.update(BLOB)
-------------------------
BOOL xdigest.update(BLOB msg)
-----------------------------
Incrementally add the BLOB to the digest context of this object.
Returns ``true`` if and only if the operation was successful.
Incrementally add the BLOB ``msg`` to the digest context of this
object. Returns ``true`` if and only if the operation was successful.
As described above: if a digest object is updated in ``vcl_init``,
then the updated context is valid for all subsequent uses of the
......@@ -280,9 +280,9 @@ task (client or backend transaction).
This method MAY NOT be called after ``.final()`` has been called
for the same object, either in ``vcl_init`` or in the current task.
The method fails and returns ``false`` if the BLOB is NULL, or if it
is called after ``.final()``. If it fails in ``vcl_init``, the VCL
load will fail with an error message. If it fails in any other VCL
The method fails and returns ``false`` if ``msg`` is NULL, or if it is
called after ``.final()``. If it fails in ``vcl_init``, the VCL load
will fail with an error message. If it fails in any other VCL
subroutine, an error message is emitted to the Varnish log with the
``VCL_Error`` tag, and the message digest context is unchanged.
......
......@@ -14,7 +14,7 @@ $ABI vrt
::
new OBJECT = blobdigest.digest(ENUM hash [, BLOB init], ["TASK"|"TOP"])
BOOL <obj>.update(BLOB)
BOOL <obj>.update(BLOB msg)
BLOB <obj>.final()
BLOB blobdigest.hash(ENUM hash, BLOB msg)
......@@ -223,10 +223,10 @@ Example::
new sha512 = blobdigest.digest(SHA512, foo.get());
}
$Method BOOL .update(BLOB)
$Method BOOL .update(BLOB msg)
Incrementally add the BLOB to the digest context of this object.
Returns ``true`` if and only if the operation was successful.
Incrementally add the BLOB ``msg`` to the digest context of this
object. Returns ``true`` if and only if the operation was successful.
As described above: if a digest object is updated in ``vcl_init``,
then the updated context is valid for all subsequent uses of the
......@@ -236,9 +236,9 @@ task (client or backend transaction).
This method MAY NOT be called after ``.final()`` has been called
for the same object, either in ``vcl_init`` or in the current task.
The method fails and returns ``false`` if the BLOB is NULL, or if it
is called after ``.final()``. If it fails in ``vcl_init``, the VCL
load will fail with an error message. If it fails in any other VCL
The method fails and returns ``false`` if ``msg`` is NULL, or if it is
called after ``.final()``. If it fails in ``vcl_init``, the VCL load
will fail with an error message. If it fails in any other VCL
subroutine, an error message is emitted to the Varnish log with the
``VCL_Error`` tag, and the message digest context is unchanged.
......
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