File 1001-Update-ei_encode_long-documentation-to-ind... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1001-Update-ei_encode_long-documentation-to-indicate-vari.patch of Package erlang (Revision 3c9c0418baf827024777fc45d8229550)

Currently displaying revision 3c9c0418baf827024777fc45d8229550 , Show latest

From 2d32e9130e5aa747616c1217b5e35b38f3194b0a Mon Sep 17 00:00:00 2001
From: Matthew Pope <mpope9@users.noreply.github.com>
Date: Fri, 16 Feb 2024 12:12:35 -0800
Subject: [PATCH] Update ei_encode_long documentation to indicate variable
 length encoding.

---
 lib/erl_interface/doc/references/ei.md | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index 2f9c4dc9b2..98bb085ea6 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -74,7 +74,10 @@
 
     <p>All encode functions assume that the <c>buf</c> and
       <c>index</c> parameters point to a buffer large enough for
-      the data. To get the size of an encoded term, without encoding it,
+      the data. Note that the binary term format uses variable-length
+      encoding so different values can require a different amount of space.
+      For example, smaller integer values can be more compact than larger ones.
+      To get the size of an encoded term, without encoding it,
       pass <c>NULL</c> instead of a buffer pointer. Parameter
       <c>index</c> is incremented, but nothing will be encoded. This
       is the way in <c>ei</c> to "preflight" term encoding.</p>
-- 
2.35.3

Places

File 1001-Update-ei_encode_long-documentation-to-indicate-vari.patch of Package erlang (Revision 3c9c0418baf827024777fc45d8229550)

Places