From 3097a53cc6bc3728f72c3873713f42d9c591ba0c Mon Sep 17 00:00:00 2001
From: Richard Carlsson <richardc@klarna.com>
Date: Tue, 15 Nov 2016 10:40:30 +0100
Subject: Minor documentation cleanup

---
 lib/kernel/doc/src/disk_log.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'lib/kernel/doc/src')

diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml
index 0b6ee1e6a5..3c9bc7f6e8 100644
--- a/lib/kernel/doc/src/disk_log.xml
+++ b/lib/kernel/doc/src/disk_log.xml
@@ -43,7 +43,7 @@
       <taglist>
 	<tag>halt logs</tag>
 	<item><p>Appends items to a single file, which size can
-	be limited by the disk log module.</p></item>
+	be limited by the <c>disk_log</c> module.</p></item>
 	<tag>wrap logs</tag>
 	<item><p>Uses a sequence of wrap log files of limited size. As a
 	wrap log file is filled up, further items are logged on to the next
@@ -62,8 +62,8 @@
 	An item logged to an internally formatted log must not occupy more
 	than 4 GB of disk space (the size must fit in 4 bytes).</p></item>
 	<tag>external format</tag>
-	<item><p>Leaves it up to the user to read the logged deep byte lists.
-	The disk log module cannot repair externally formatted logs.</p></item>
+	<item><p>Leaves it up to the user to read and interpret the logged data.
+	The <c>disk_log</c> module cannot repair externally formatted logs.</p></item>
       </taglist>
 
     <p>For each open disk log, one process handles requests
-- 
cgit v1.2.3


From 9bb7aee366b04f6e8b6ea8491c0d7ebbdb304bb6 Mon Sep 17 00:00:00 2001
From: Richard Carlsson <richardc@klarna.com>
Date: Tue, 15 Nov 2016 18:49:39 +0100
Subject: Clarify that the type for disk log data is iodata()

---
 lib/kernel/doc/src/disk_log.xml | 13 +++----------
 1 file changed, 3 insertions(+), 10 deletions(-)

(limited to 'lib/kernel/doc/src')

diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml
index 3c9bc7f6e8..aebeacee28 100644
--- a/lib/kernel/doc/src/disk_log.xml
+++ b/lib/kernel/doc/src/disk_log.xml
@@ -109,8 +109,7 @@
       These functions log one or more Erlang terms.
       By prefixing each of the functions with a <c>b</c> (for "binary"),
       we get the corresponding <c>blog()</c> functions for the external format.
-      These functions log one or more deep lists of bytes or, alternatively,
-      binaries of deep lists of bytes.
+      These functions log one or more chunks of bytes.
       For example, to log the string <c>"hello"</c> in ASCII format, you
       can use <c>disk_log:blog(Log, "hello")</c>, or
       <c>disk_log:blog(Log, list_to_binary("hello"))</c>. The two
@@ -218,9 +217,6 @@
     <datatype>
       <name name="dlog_head_opt"/>
     </datatype>
-    <datatype>
-      <name name="dlog_byte"/>
-    </datatype>
     <datatype>
       <name name="dlog_mode"/>
     </datatype>
@@ -233,9 +229,6 @@
          <c>chunk/2,3</c>, <c>bchunk/2,3</c>, or <c>chunk_step/3</c>.</p>
       </desc>
     </datatype>
-    <datatype>
-      <name name="bytes"/>
-    </datatype>
     <datatype>
       <name name="invalid_header"/>
     </datatype>
@@ -953,7 +946,7 @@
               written first on the log file. If the log is a wrap
               log, the item <c><anno>Head</anno></c> is written first in each new file.
               <c><anno>Head</anno></c> is to be a term if the format is
-              <c>internal</c>, otherwise a deep list of bytes (or a binary).
+              <c>internal</c>, otherwise a sequence of bytes.
               Defaults to <c>none</c>, which means that
               no header is written first on the file.
               </p>
@@ -965,7 +958,7 @@
               The call <c>M:F(A)</c> is assumed to return <c>{ok, Head}</c>.
               The item <c>Head</c> is written first in each file.
               <c>Head</c> is to be a term if the format is
-              <c>internal</c>, otherwise a deep list of bytes (or a binary).
+              <c>internal</c>, otherwise a sequence of bytes.
               </p>
           </item>
 	  <tag><c>{mode, <anno>Mode</anno>}</c></tag>
-- 
cgit v1.2.3