From 9d24762ee16bb8325b3a5589d4ec9fe8111b8209 Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Fri, 20 Feb 2015 15:02:31 -0500 Subject: [PATCH] README.md: adding example output --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/README.md b/README.md index 2633611..2216d70 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,69 @@ Contract Do not break the API of stdlib `archive/tar` +Example +------- + +First we'll get an archive to work with. For repeatability, we'll make an +archive from what you've just cloned: + +``` +git archive --format=tar -o tar-split.tar HEAD . +``` + +Then build the example main.go: + +``` +go build ./main.go +``` + +Now run the example over the archive: + +``` +$ ./main tar-split.tar +2015/02/20 15:00:58 writing "tar-split.tar" to "tar-split.tar.out" +pax_global_header pre: 512 read: 52 post: 0 +LICENSE pre: 972 read: 1075 post: 0 +README.md pre: 973 read: 1004 post: 0 +archive/ pre: 532 read: 0 post: 0 +archive/tar/ pre: 512 read: 0 post: 0 +archive/tar/common.go pre: 512 read: 7790 post: 0 +archive/tar/example_test.go pre: 914 read: 1659 post: 0 +archive/tar/reader.go pre: 901 read: 25303 post: 0 +archive/tar/reader_test.go pre: 809 read: 17513 post: 0 +archive/tar/stat_atim.go pre: 919 read: 414 post: 0 +archive/tar/stat_atimespec.go pre: 610 read: 414 post: 0 +archive/tar/stat_unix.go pre: 610 read: 716 post: 0 +archive/tar/tar_test.go pre: 820 read: 6673 post: 0 +archive/tar/testdata/ pre: 1007 read: 0 post: 0 +archive/tar/testdata/gnu.tar pre: 512 read: 3072 post: 0 +archive/tar/testdata/nil-uid.tar pre: 512 read: 1024 post: 0 +archive/tar/testdata/pax.tar pre: 512 read: 10240 post: 0 +archive/tar/testdata/small.txt pre: 512 read: 5 post: 0 +archive/tar/testdata/small2.txt pre: 1019 read: 11 post: 0 +archive/tar/testdata/sparse-formats.tar pre: 1013 read: 17920 post: 0 +archive/tar/testdata/star.tar pre: 512 read: 3072 post: 0 +archive/tar/testdata/ustar.tar pre: 512 read: 2048 post: 0 +archive/tar/testdata/v7.tar pre: 512 read: 3584 post: 0 +archive/tar/testdata/writer-big-long.tar pre: 512 read: 4096 post: 0 +archive/tar/testdata/writer-big.tar pre: 512 read: 4096 post: 0 +archive/tar/testdata/writer.tar pre: 512 read: 3584 post: 0 +archive/tar/testdata/xattrs.tar pre: 512 read: 5120 post: 0 +archive/tar/writer.go pre: 512 read: 11867 post: 0 +archive/tar/writer_test.go pre: 933 read: 12436 post: 0 +main.go pre: 876 read: 1568 post: 0 +old.go pre: 992 read: 4918 post: 0 +Size: 174080; Sum: 174080 +``` + +Ideally the input tar and output `*.out`, will match: + +``` +$ sha1sum tar-split.tar* +ca9e19966b892d9ad5960414abac01ef585a1e22 tar-split.tar +ca9e19966b892d9ad5960414abac01ef585a1e22 tar-split.tar.out +``` + License -------