diff options
| author | Richard Carlsson <[email protected]> | 2016-11-15 18:49:39 +0100 |
|---|---|---|
| committer | Richard Carlsson <[email protected]> | 2016-11-29 10:30:44 +0100 |
| commit | 9bb7aee366b04f6e8b6ea8491c0d7ebbdb304bb6 (patch) | |
| tree | e554b890ac8191a13068f3839ab9e8608feabce7 /lib/kernel/doc | |
| parent | 08d22e7658542279711753f3363299105bd669bb (diff) | |
| download | otp-9bb7aee366b04f6e8b6ea8491c0d7ebbdb304bb6.tar.gz otp-9bb7aee366b04f6e8b6ea8491c0d7ebbdb304bb6.tar.bz2 otp-9bb7aee366b04f6e8b6ea8491c0d7ebbdb304bb6.zip | |
Clarify that the type for disk log data is iodata()
Diffstat (limited to 'lib/kernel/doc')
| -rw-r--r-- | lib/kernel/doc/src/disk_log.xml | 13 |
1 files changed, 3 insertions, 10 deletions
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 @@ -219,9 +218,6 @@ <name name="dlog_head_opt"/> </datatype> <datatype> - <name name="dlog_byte"/> - </datatype> - <datatype> <name name="dlog_mode"/> </datatype> <datatype> @@ -234,9 +230,6 @@ </desc> </datatype> <datatype> - <name name="bytes"/> - </datatype> - <datatype> <name name="invalid_header"/> </datatype> <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> |