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/erl_tar.xml | 60 +++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 33 deletions(-) (limited to 'lib/stdlib/doc/src/erl_tar.xml') 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".)

 -- cgit v1.2.3