aboutsummaryrefslogtreecommitdiffstats
path: root/docs/miscellaneous.rst
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2018-06-26 08:23:02 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2018-06-26 08:23:02 +0800
commit44f2cfb5cadab4ef40e62015f546cb7c9c78c491 (patch)
tree73e8bbd052f8f1d01f4fa19bd40fd132bd7b0ccc /docs/miscellaneous.rst
parent4be9dc430452ca73ffb07f987f27fb6ccf4ac848 (diff)
downloaddexon-solidity-44f2cfb5cadab4ef40e62015f546cb7c9c78c491.tar.gz
dexon-solidity-44f2cfb5cadab4ef40e62015f546cb7c9c78c491.tar.zst
dexon-solidity-44f2cfb5cadab4ef40e62015f546cb7c9c78c491.zip
Clarify that using msize without updating the free-memory-pointer is a bad idea
Diffstat (limited to 'docs/miscellaneous.rst')
-rw-r--r--docs/miscellaneous.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/miscellaneous.rst b/docs/miscellaneous.rst
index 108d4c96..f6cfdc2c 100644
--- a/docs/miscellaneous.rst
+++ b/docs/miscellaneous.rst
@@ -79,6 +79,7 @@ Solidity always places new objects at the free memory pointer and memory is neve
.. warning::
There are some operations in Solidity that need a temporary memory area larger than 64 bytes and therefore will not fit into the scratch space. They will be placed where the free memory points to, but given their short lifecycle, the pointer is not updated. The memory may or may not be zeroed out. Because of this, one shouldn't expect the free memory to be zeroed out.
+ While it may seem like a good idea to use ``msize`` to arrive at a definitely zeroed out memory area, using such a pointer non-temporarily without updating the free memory pointer can have adverse results.
.. index: calldata layout