Skip to content

Commit 062dc68

Browse files
behlendorfbehlendorf
committed
Fix README.markdown formating
Update the README.markdown file so that it's rendered correctly. The table formating was removed and links were added to the pool tarballs and relevant issues. Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
1 parent e8a8374 commit 062dc68

File tree

1 file changed

+60
-70
lines changed

1 file changed

+60
-70
lines changed

‎README.markdown

Lines changed: 60 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -12,73 +12,63 @@ compressible data patterns, and using the 'tar --sparse' and 'bzip2 --best'
1212
options. Finally, each new image must be briefly described in this file.
1313

1414

15-
Name | Description
16-
---------------------- | ------------------------------------------------
17-
zol-0.6.1 | Created with ZoL v0.6.1
18-
|
19-
| The pool was created with all default settings and
20-
| populated with a few hundred files and directories.
21-
| It includes a snapshot and clone of the filesystem
22-
| which has been modified from the original. The pool
23-
| has been scrubbed once and was cleanly exported.
24-
|
25-
zol-0.6.2 | Created with ZoL v0.6.2
26-
|
27-
| This pool was created in same way as the zol-0.6.1
28-
| pool described above.
29-
|
30-
zol-0.6.2-173 | Created with ZoL zfs-0.6.2-173-g881f45c
31-
|
32-
| Pools which have been imported with this version of
33-
| ZoL and scrubbed or resilvered cannot be imported by
34-
| older versions of ZFS. This was accidentally caused
35-
| by https://github.com/zfsonlinux/zfs/issues/2094 and
36-
| this pool was created for future reference. New ZoL
37-
| versions must be able to import the pool and fix it.
38-
| It was created the same was as the zol-0.6.1 pool.
39-
|
40-
zevo-1.1.1 | Created with ZEVO v1.1.1
41-
|
42-
| This pool was created to illustrate differences in
43-
| the on disk format of a ZEVO pool. In particular,
44-
| https://github.com/zfsonlinux/zfs/issues/1911
45-
| describes how neither an "external ACL" (ZNODE_ACL)
46-
| nor a new-style DACL_ACES SA are created. One of
47-
| these is required by all other ZFS implementations.
48-
|
49-
bptree_obj-zol-0.6.2 | Created with ZoL v0.6.2
50-
|
51-
| This pool was created to illustrate one of the many
52-
| states in which a valid exported pool may exist.
53-
| It contains the optional "bptree_obj" entry in the
54-
| MOS object directory which points to an object of
55-
| type DMU_OTN_UINT64_METADATA containing a pair of
56-
| bptree_entry_phys_t entries; one for each of a
57-
| pair of filesystems for which a deferred destroy is
58-
| pending. Although ZoL 0.6.2 was used to create this
59-
| pool, it was custom-modified to not process the
60-
| deferred destroy list in order to create this pool
61-
| cleanly. The pool's name is "tank" and it contained
62-
| a pair of filesystemes, "tank/fs1" and "tank/fs2",
63-
| each of which contained a single small file. The
64-
| deferred destroy object and its object's data were
65-
| created by destroying both of these filesystems.
66-
|
67-
zol-0.7.0-rc1-be-ziltest| This pool was created so that we might have a big
68-
| endian pool for debugging. The pool was created using
69-
| ziltest.sh, since at the time of uploading there are
70-
| is an issue where the ZIL will fail to be claimed when
71-
| being imported on a different endian machine. See
72-
| https://github.com/zfsonlinux/zfs/issues/5256 for
73-
| details on this problem. The pool's name is
74-
| ziltest.26210 and it contains the "ziltest.26210/fs"
75-
| filesystem made by ziltest.sh.
76-
|
77-
zol-znode-removed-xattr| This pool was created to be a minimal reproducer of
78-
| https://github.com/zfsonlinux/zfs/issues/4083.
79-
| The pool contains a single filesystem "tank" with only
80-
| a file "file2" in it. When we try to delete the file we
81-
| trigger an assertion in zfs_remove(): this is because
82-
| the file xattr obj was already deleted. This data
83-
| discrepancy is not detected by a scrub which completes
84-
| successfully.
15+
* [zol-0.6.1.tar.bz2] - Created with ZoL v0.6.1. The pool was created with
16+
all default settings and populated with a few hundred files and directories.
17+
It includes a snapshot and clone of the filesystem which has been modified
18+
from the original. The pool has been scrubbed once and was cleanly exported.
19+
20+
* [zol-0.6.2.tar.bz2] - Created with ZoL v0.6.2. This pool was created in same
21+
way as the zol-0.6.1 pool described above.
22+
23+
* [zol-0.6.2-173.tar.bz2] - Created with ZoL zfs-0.6.2-173-g881f45c. Pools which
24+
have been imported with this version of ZoL and scrubbed or resilvered cannot
25+
be imported by older versions of ZFS. This was accidentally caused by
26+
[issue 2094] and this pool was created for future reference. New ZoL
27+
versions must be able to import the pool and fix it. It was created the
28+
same was as the zol-0.6.1 pool.
29+
30+
* [zevo-1.1.1.tar.bz2] - Created with ZEVO v1.1.1. This pool was created to
31+
illustrate differences in the on disk format of a ZEVO pool. In particular,
32+
[issue 1911] describes how neither an "external ACL" (ZNODE_ACL) nor a
33+
new-style DACL_ACES SA are created. One of these is required by all other
34+
ZFS implementations.
35+
36+
* [bptree_obj-zol-0.6.2.tar.bz2] - Created with ZoL v0.6.2. This pool was
37+
created to illustrate one of the many states in which a valid exported
38+
pool may exist. It contains the optional "bptree_obj" entry in the
39+
MOS object directory which points to an object of type
40+
DMU_OTN_UINT64_METADATA containing a pair of bptree_entry_phys_t entries;
41+
one for each of a pair of filesystems for which a deferred destroy is
42+
pending. Although ZoL 0.6.2 was used to create this pool, it was
43+
custom-modified to not process the deferred destroy list in order to
44+
create this pool cleanly. The pool's name is "tank" and it contained
45+
a pair of filesystemes, "tank/fs1" and "tank/fs2", each of which contained
46+
a single small file. The deferred destroy object and its object's data were
47+
created by destroying both of these filesystems.
48+
49+
* [zol-0.7.0-rc1-be-ziltest.tar.bz2] - This pool was created so that we might
50+
have a big endian pool for debugging. The pool was created using ziltest.sh,
51+
since at the time of uploading there are is an issue where the ZIL will fail
52+
to be claimed when being imported on a different endian machine. See
53+
[issue 5256] for details on this problem. The pool's name is ziltest.26210
54+
and it contains the "ziltest.26210/fs" filesystem made by ziltest.sh.
55+
56+
* [zol-znode-removed-xattr.tar.bz2] - This pool was created to be a minimal
57+
reproducer of [issue 4083]. The pool contains a single filesystem "tank"
58+
with only a file "file2" in it. When we try to delete the file we trigger
59+
an assertion in zfs_remove(): this is because the file xattr obj was
60+
already deleted. This data discrepancy is not detected by a scrub which
61+
completes successfully.
62+
63+
[zol-0.6.1.tar.bz2]: ./zol-0.6.1.tar.bz2
64+
[zol-0.6.2.tar.bz2]: ./zol-0.6.2.tar.bz2
65+
[zol-0.6.2-173.tar.bz2]: ./zol-0.6.2-173.tar.bz2
66+
[zevo-1.1.1.tar.bz2]: ./zevo-1.1.1.tar.bz2
67+
[bptree_obj-zol-0.6.2.tar.bz2]: ./bptree_obj-zol-0.6.2.tar.bz2
68+
[zol-0.7.0-rc1-be-ziltest.tar.bz2]: ./zol-0.7.0-rc1-be-ziltest.tar.bz2
69+
[zol-znode-removed-xattr.tar.bz2]: ./zol-znode-removed-xattr.tar.bz2
70+
71+
[issue 2094]: https://github.com/zfsonlinux/zfs/issues/2094
72+
[issue 1911]: https://github.com/zfsonlinux/zfs/issues/1911
73+
[issue 5256]: https://github.com/zfsonlinux/zfs/issues/5256
74+
[issue 4083]: https://github.com/zfsonlinux/zfs/issues/4083

0 commit comments

Comments
 (0)