From 61138cb31e1f6ad44d3ca54e668de9d2d4adb2ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 9 Apr 2014 12:42:32 +0200 Subject: Support path names with characters outside the US ASCII range --- lib/stdlib/doc/src/erl_tar.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lib/stdlib/doc') diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index f81e36f810..afa4196be1 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -64,6 +64,20 @@ format_error/1 function.

+
+ UNICODE SUPPORT +

If file:native_name_encoding/0 + returns utf8, path names will be encoded in UTF-8 when + creating tar files and path names will be assumed to be encoded in + UTF-8 when extracting tar files.

+ +

If file:native_name_encoding/0 + returns latin1, no translation of path names will be + done.

+
+
LIMITATIONS

For maximum compatibility, it is safe to archive files with names -- cgit v1.2.3 From fa67c39896487a3f6f382d8a38c3663ca25646af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Thu, 10 Apr 2014 13:55:01 +0200 Subject: Update information about compatibility GNU tar now supports the 'ustar' format. --- lib/stdlib/doc/src/erl_tar.xml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'lib/stdlib/doc') diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index afa4196be1..ccf0f3901f 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -35,10 +35,11 @@ Unix 'tar' utility for reading and writing tar archives

The erl_tar module archives and extract files to and from - a tar file. The tar file format is the POSIX extended tar file format - specified in IEEE Std 1003.1 and ISO/IEC 9945-1. That is the same - format as used by tar program on Solaris, but is not the same - as used by the GNU tar program.

+ a tar file. erl_tar supports the ustar format + (IEEE Std 1003.1 and ISO/IEC 9945-1). All modern tar + programs (including GNU tar) can read this format. To ensure that + that GNU tar produces a tar file that erl_tar can read, + give the --format=ustar option to GNU tar.

By convention, the name of a tar file should end in ".tar". To abide to the convention, you'll need to add ".tar" yourself to the name.

-- cgit v1.2.3 From 92a5b09ed50c905a6480b74f10af770d98eea5bd Mon Sep 17 00:00:00 2001 From: Yuki Ito Date: Sat, 12 Apr 2014 20:46:26 +0900 Subject: Fix typo in erl_tar docs --- lib/stdlib/doc/src/erl_tar.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/stdlib/doc') diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index ccf0f3901f..6d5b07059a 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -128,7 +128,7 @@ TarDescriptor = term() FilenameOrBin = Filename()|binary() - Filename = filename()() + Filename = filename() NameInArchive = filename() Options = [Option] Option = dereference|verbose -- cgit v1.2.3 From d02469d12f103276345dc0a3b024f76f6d6763fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Thu, 17 Apr 2014 12:09:20 +0200 Subject: Correct typo in type specification Types start with a lower-case letter. --- lib/stdlib/doc/src/erl_tar.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/stdlib/doc') diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 6d5b07059a..7f25f5b7bc 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -127,7 +127,7 @@ Add a file to an open tar file TarDescriptor = term() - FilenameOrBin = Filename()|binary() + FilenameOrBin = filename()|binary() Filename = filename() NameInArchive = filename() Options = [Option] -- cgit v1.2.3