From ee205b29f7a2bb92aeef55ca88fccc8c91f22ec0 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Mon, 19 Sep 2011 15:36:08 +0200 Subject: Correct XML files --- lib/stdlib/doc/src/beam_lib.xml | 1 - lib/stdlib/doc/src/dets.xml | 3 +- lib/stdlib/doc/src/erl_tar.xml | 60 ++++++++++++++++++--------------------- lib/stdlib/doc/src/ets.xml | 15 +++++----- lib/stdlib/doc/src/gb_sets.xml | 1 - lib/stdlib/doc/src/gen_fsm.xml | 3 +- lib/stdlib/doc/src/notes.xml | 3 +- lib/stdlib/doc/src/qlc.xml | 1 - lib/stdlib/doc/src/supervisor.xml | 1 - lib/stdlib/doc/src/timer.xml | 13 +++++---- lib/stdlib/doc/src/zip.xml | 22 ++++++-------- 11 files changed, 54 insertions(+), 69 deletions(-) (limited to 'lib/stdlib/doc/src') diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index 013e94c393..db65eb3848 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -88,7 +88,6 @@ it is recommended that it contains at least 32 characters and that both upper and lower case letters as well as digits and special characters are used.

-

The default type -- and currently the only type -- of crypto algorithm is des3_cbc, three rounds of DES. The key string will be scrambled using erlang:md5/1 to generate diff --git a/lib/stdlib/doc/src/dets.xml b/lib/stdlib/doc/src/dets.xml index 54fefbe2b8..215ec154ed 100644 --- a/lib/stdlib/doc/src/dets.xml +++ b/lib/stdlib/doc/src/dets.xml @@ -1006,8 +1006,7 @@ ok Return a QLC query handle. -

- Returns a QLC (Query List +

Returns a QLC (Query List Comprehension) query handle. The module qlc implements a query language aimed mainly at Mnesia but Ets tables, Dets tables, and lists are also recognized by qlc diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 929620bb88..fe166dbd01 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -4,7 +4,7 @@

- 20032009 + 20032011 Ericsson AB. All Rights Reserved. @@ -89,9 +89,8 @@ Reason = term() -

The -add/3 function adds a file to a tar file - that has been opened for writing by +

The add/3 function adds + a file to a tar file that has been opened for writing by open/1.

dereference @@ -138,8 +137,8 @@ TarDescriptor = term() -

The -close/1 function closes a tar file +

The close/1 function + closes a tar file opened by open/1.

 @@ -151,11 +150,12 @@ FileList = [Filename|{NameInArchive, binary()},{NameInArchive, Filename}] Filename = filename() NameInArchive = filename() - RetValue = ok|{error,{Name,Reason}} <V>Reason = term() + RetValue = ok|{error,{Name,Reason}} + Reason = term() -

The -create/2 function creates a tar file and +

The create/2 function + creates a tar file and archives the files whose names are given in FileList into it. The files may either be read from disk or given as binaries.

@@ -171,11 +171,11 @@ NameInArchive = filename() OptionList = [Option] Option = compressed|cooked|dereference|verbose - RetValue = ok|{error,{Name,Reason}} <V>Reason = term() + RetValue = ok|{error,{Name,Reason}} + Reason = term() -

The -create/3 function +

The create/3 function creates a tar file and archives the files whose names are given in FileList into it. The files may either be read from disk or given as binaries.

@@ -220,9 +220,8 @@ Reason = term() -

The -extract/1 function extracts - all files from a tar archive.

+

The extract/1 function + extracts all files from a tar archive.

If the Name argument is given as "{binary,Binary}", the contents of the binary is assumed to be a tar archive.

@@ -250,9 +249,8 @@ Reason = term() -

The -extract/2 function extracts - files from a tar archive.

+

The extract/2 function + extracts files from a tar archive.

If the Name argument is given as "{binary,Binary}", the contents of the binary is assumed to be a tar archive.

@@ -322,8 +320,8 @@ Reason = term() -

The -format_error/1 converts +

The format_error/1 + function converts an error reason term to a human-readable error message string.

 @@ -339,8 +337,8 @@ Reason = term() -

The -open/2 function creates a tar file for writing. +

The open/2 function creates + a tar file for writing. (Any existing file with the same name will be truncated.)

By convention, the name of a tar file should end in ".tar". To abide to the convention, you'll need to add ".tar" yourself @@ -373,7 +371,6 @@ You should not rely on the specific contents of the TarDescriptor term, as it may change in future versions as more features are added to the erl_tar module.

-

@@ -386,9 +383,8 @@ Reason = term() -

The -table/1 function retrieves - the names of all files in the tar file Name.

+

The table/1 function + retrieves the names of all files in the tar file Name.

 @@ -398,9 +394,8 @@ Name = filename() -

The -table/2 function retrieves - the names of all files in the tar file Name.

+

The table/2 function + retrieves the names of all files in the tar file Name.

 @@ -410,8 +405,7 @@ Name = filename() -

The -t/1 function prints the names +

The t/1 function prints the names of all files in the tar file Name to the Erlang shell. (Similar to "tar t".)

 @@ -423,8 +417,8 @@ Name = filename() -

The -tt/1 function prints names and +

The tt/1 function prints + names and information about all files in the tar file Name to the Erlang shell. (Similar to "tar tv".)

 diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index f19f92be6f..efd9514db6 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -512,11 +512,10 @@ Error: fun containing local Erlang function calls of the reference counter, keeping track of how many times the table has been fixed by the process.

If the table never has been fixed, the call returns - false.

- Item=stats, Value=tuple()

+ false.

 +

Item=stats, Value=tuple()

Returns internal statistics about set, bag and duplicate_bag tables on an internal format used by OTP test suites. - Not for production use. - + Not for production use.

 @@ -661,9 +660,9 @@ ets:is_compiled_ms(Broken). table. The difference being the same as between =:= and ==. As an example, one might insert an object with the - integer()1 as a key in an ordered_set + integer() 1 as a key in an ordered_set and get the object returned as a result of doing a - lookup/2 with the float()1.0 as the + lookup/2 with the float() 1.0 as the key to search for.

If the table is of type set or ordered_set, the function returns either the empty list or a list with one @@ -946,7 +945,7 @@ ets:select(Table,MatchSpec), table is named or not. If one or more options are left out, the default values are used. This means that not specifying any options ([]) is the same as specifying - [set,protected,{keypos,1},{heir,none},{write_concurrency,false},{read_concurrency,false}].

+ [set, protected, {keypos,1}, {heir,none}, {write_concurrency,false}, {read_concurrency,false}].

set @@ -963,7 +962,7 @@ ets:select(Table,MatchSpec), ordered_set tables regard keys as equal when they compare equal, not only when they match. This means that to an ordered_set, the - integer()1 and the float()1.0 are regarded as equal. This also means that the + integer() 1 and the float() 1.0 are regarded as equal. This also means that the key used to lookup an element not necessarily matches the key in the elements returned, if float()'s and integer()'s are mixed in diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index 38de51322f..f91fac9c82 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -61,7 +61,6 @@ and do the same thing in the sets and ordsets modules. That is, by only changing the module name for each call, you can try out different set representations.

-

add_element/2

diff --git a/lib/stdlib/doc/src/gen_fsm.xml b/lib/stdlib/doc/src/gen_fsm.xml index e35b5adace..421eeb4fd3 100644 --- a/lib/stdlib/doc/src/gen_fsm.xml +++ b/lib/stdlib/doc/src/gen_fsm.xml @@ -4,7 +4,7 @@
- 19962010 + 19962011 Ericsson AB. All Rights Reserved. @@ -430,7 +430,6 @@ gen_fsm:sync_send_all_state_event -----> Module:handle_sync_event/4 denote a state of the state machine. state data is used to denote the internal state of the Erlang process which implements the state machine.

-

diff --git a/lib/stdlib/doc/src/notes.xml b/lib/stdlib/doc/src/notes.xml index 60c0b91212..36089f2603 100644 --- a/lib/stdlib/doc/src/notes.xml +++ b/lib/stdlib/doc/src/notes.xml @@ -2632,7 +2632,7 @@ that is, also when starting a gen_server, gen_fsm etc.

This limitation has now been properly documented and the behavior of the gen_fsm, gen_server, and - proc_libstart and start_link + proc_lib start and start_link functions when providing this option has been changed from hanging indefinitely to failing with reason badarg.

@@ -2749,7 +2749,6 @@ join option that can be used to force QLC to use a particular kind of join in some QLC expression.

Several other changes have also been included:

-

The new tmpdir option of cursor/2, diff --git a/lib/stdlib/doc/src/qlc.xml b/lib/stdlib/doc/src/qlc.xml index 6a45ade447..ce50631ca9 100644 --- a/lib/stdlib/doc/src/qlc.xml +++ b/lib/stdlib/doc/src/qlc.xml @@ -688,7 +688,6 @@ ets:match_spec_run(ets:lookup(86033, {2,2}), -

diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index edd119d37a..ec607d6e4c 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -59,7 +59,6 @@ processes are started in order from left to right according to this list. When the supervisor terminates, it first terminates its child processes in reversed start order, from right to left.

-

A supervisor can have one of the following restart strategies:

diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index b741ab7db1..0c1e398dc4 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -84,7 +84,7 @@ Send Messageto Pidafter a specified Time. -

+

send_after/3 @@ -98,6 +98,7 @@

Same as send_after(Time, self(), Message).

 +

@@ -107,7 +108,7 @@ Send an exit signal with Reasonafter a specified Time. -

+

exit_after/3 @@ -128,6 +129,7 @@

Same as exit_after(Time, self(), kill).

+

@@ -144,7 +146,7 @@ Send Messagerepeatedly at intervals of Time. -

+

send_interval/3 @@ -158,6 +160,7 @@

Same as send_interval(Time, self(), Message).

+

@@ -188,7 +191,7 @@ Function, Arguments) or apply(Fun, Arguments) In microseconds -

+

tc/3 @@ -209,6 +212,7 @@ +

@@ -254,7 +258,6 @@
Examples

This example illustrates how to print out "Hello World!" in 5 seconds:

- 

       1> timer:apply_after(5000, io, format, ["~nHello World!~n", []]).
       {ok,TRef}
diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml
index b03fc7f4e2..cf0d581352 100644
--- a/lib/stdlib/doc/src/zip.xml
+++ b/lib/stdlib/doc/src/zip.xml
@@ -243,12 +243,10 @@
       
       Extract files from a zip archive
       
-        
The           
-unzip/1 function extracts
-          all files from a zip archive. The
-                    
-unzip/2 function provides options
-          to extract some files, and more.

+        
The unzip/1 function extracts
+          all files from a zip archive.
+          The unzip/2 function provides
+           options to extract some files, and more.

         
If the Archive argument is given as a binary,
           the contents of the binary is assumed to be a zip archive,
           otherwise it should be a filename.

@@ -413,8 +411,8 @@
       
       Open an archive and return a handle to it
       
-        
The           
-zip_open function opens a
+        
The zip_open function
+          opens a
           zip archive, and reads and saves its directory. This
           means that subsequently reading files from the archive will be
           faster than unzipping files one at a time with unzip.

@@ -436,8 +434,7 @@
       
       Extract files from an open archive
       
-        
The           
-zip_get function extracts
+        
The zip_get function extracts
           one or all files from an open archive.

         
The files will be unzipped to memory or to file, depending on
           the options given to the zip_open function when the
@@ -448,9 +445,8 @@
       
       Close an open archive
       
-        
The           
-zip_close/1 function closes
-          a zip archive, previously opened with zip_open. All
+        
The zip_close/1 function
+          closes a zip archive, previously opened with zip_open. All
           resources are closed, and the handle should not be used after
           closing.

       
-- 
cgit v1.2.3