Skip to content

Commit

Permalink
Fix README.markdown formating
Browse files Browse the repository at this point in the history 
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 <[email protected]>
  • Loading branch information
@behlendorf
behlendorf committed Feb 24, 2020
1 parent e8a8374 commit 062dc68
Showing 1 changed file with 60 additions and 70 deletions.
130 changes: 60 additions & 70 deletions README.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,73 +12,63 @@ compressible data patterns, and using the 'tar --sparse' and 'bzip2 --best'
options. Finally, each new image must be briefly described in this file.


Name | Description
---------------------- | ------------------------------------------------
zol-0.6.1 | Created with ZoL v0.6.1
|
| The pool was created with all default settings and
| populated with a few hundred files and directories.
| It includes a snapshot and clone of the filesystem
| which has been modified from the original. The pool
| has been scrubbed once and was cleanly exported.
|
zol-0.6.2 | Created with ZoL v0.6.2
|
| This pool was created in same way as the zol-0.6.1
| pool described above.
|
zol-0.6.2-173 | Created with ZoL zfs-0.6.2-173-g881f45c
|
| Pools which have been imported with this version of
| ZoL and scrubbed or resilvered cannot be imported by
| older versions of ZFS. This was accidentally caused
| by https://github.com/zfsonlinux/zfs/issues/2094 and
| this pool was created for future reference. New ZoL
| versions must be able to import the pool and fix it.
| It was created the same was as the zol-0.6.1 pool.
|
zevo-1.1.1 | Created with ZEVO v1.1.1
|
| This pool was created to illustrate differences in
| the on disk format of a ZEVO pool. In particular,
| https://github.com/zfsonlinux/zfs/issues/1911
| describes how neither an "external ACL" (ZNODE_ACL)
| nor a new-style DACL_ACES SA are created. One of
| these is required by all other ZFS implementations.
|
bptree_obj-zol-0.6.2 | Created with ZoL v0.6.2
|
| This pool was created to illustrate one of the many
| states in which a valid exported pool may exist.
| It contains the optional "bptree_obj" entry in the
| MOS object directory which points to an object of
| type DMU_OTN_UINT64_METADATA containing a pair of
| bptree_entry_phys_t entries; one for each of a
| pair of filesystems for which a deferred destroy is
| pending. Although ZoL 0.6.2 was used to create this
| pool, it was custom-modified to not process the
| deferred destroy list in order to create this pool
| cleanly. The pool's name is "tank" and it contained
| a pair of filesystemes, "tank/fs1" and "tank/fs2",
| each of which contained a single small file. The
| deferred destroy object and its object's data were
| created by destroying both of these filesystems.
|
zol-0.7.0-rc1-be-ziltest| This pool was created so that we might have a big
| endian pool for debugging. The pool was created using
| ziltest.sh, since at the time of uploading there are
| is an issue where the ZIL will fail to be claimed when
| being imported on a different endian machine. See
| https://github.com/zfsonlinux/zfs/issues/5256 for
| details on this problem. The pool's name is
| ziltest.26210 and it contains the "ziltest.26210/fs"
| filesystem made by ziltest.sh.
|
zol-znode-removed-xattr| This pool was created to be a minimal reproducer of
| https://github.com/zfsonlinux/zfs/issues/4083.
| The pool contains a single filesystem "tank" with only
| a file "file2" in it. When we try to delete the file we
| trigger an assertion in zfs_remove(): this is because
| the file xattr obj was already deleted. This data
| discrepancy is not detected by a scrub which completes
| successfully.
* [zol-0.6.1.tar.bz2] - Created with ZoL v0.6.1. The pool was created with
all default settings and populated with a few hundred files and directories.
It includes a snapshot and clone of the filesystem which has been modified
from the original. The pool has been scrubbed once and was cleanly exported.

* [zol-0.6.2.tar.bz2] - Created with ZoL v0.6.2. This pool was created in same
way as the zol-0.6.1 pool described above.

* [zol-0.6.2-173.tar.bz2] - Created with ZoL zfs-0.6.2-173-g881f45c. Pools which
have been imported with this version of ZoL and scrubbed or resilvered cannot
be imported by older versions of ZFS. This was accidentally caused by
[issue 2094] and this pool was created for future reference. New ZoL
versions must be able to import the pool and fix it. It was created the
same was as the zol-0.6.1 pool.

* [zevo-1.1.1.tar.bz2] - Created with ZEVO v1.1.1. This pool was created to
illustrate differences in the on disk format of a ZEVO pool. In particular,
[issue 1911] describes how neither an "external ACL" (ZNODE_ACL) nor a
new-style DACL_ACES SA are created. One of these is required by all other
ZFS implementations.

* [bptree_obj-zol-0.6.2.tar.bz2] - Created with ZoL v0.6.2. This pool was
created to illustrate one of the many states in which a valid exported
pool may exist. It contains the optional "bptree_obj" entry in the
MOS object directory which points to an object of type
DMU_OTN_UINT64_METADATA containing a pair of bptree_entry_phys_t entries;
one for each of a pair of filesystems for which a deferred destroy is
pending. Although ZoL 0.6.2 was used to create this pool, it was
custom-modified to not process the deferred destroy list in order to
create this pool cleanly. The pool's name is "tank" and it contained
a pair of filesystemes, "tank/fs1" and "tank/fs2", each of which contained
a single small file. The deferred destroy object and its object's data were
created by destroying both of these filesystems.

* [zol-0.7.0-rc1-be-ziltest.tar.bz2] - This pool was created so that we might
have a big endian pool for debugging. The pool was created using ziltest.sh,
since at the time of uploading there are is an issue where the ZIL will fail
to be claimed when being imported on a different endian machine. See
[issue 5256] for details on this problem. The pool's name is ziltest.26210
and it contains the "ziltest.26210/fs" filesystem made by ziltest.sh.

* [zol-znode-removed-xattr.tar.bz2] - This pool was created to be a minimal
reproducer of [issue 4083]. The pool contains a single filesystem "tank"
with only a file "file2" in it. When we try to delete the file we trigger
an assertion in zfs_remove(): this is because the file xattr obj was
already deleted. This data discrepancy is not detected by a scrub which
completes successfully.

[zol-0.6.1.tar.bz2]: ./zol-0.6.1.tar.bz2
[zol-0.6.2.tar.bz2]: ./zol-0.6.2.tar.bz2
[zol-0.6.2-173.tar.bz2]: ./zol-0.6.2-173.tar.bz2
[zevo-1.1.1.tar.bz2]: ./zevo-1.1.1.tar.bz2
[bptree_obj-zol-0.6.2.tar.bz2]: ./bptree_obj-zol-0.6.2.tar.bz2
[zol-0.7.0-rc1-be-ziltest.tar.bz2]: ./zol-0.7.0-rc1-be-ziltest.tar.bz2
[zol-znode-removed-xattr.tar.bz2]: ./zol-znode-removed-xattr.tar.bz2

[issue 2094]: https://github.com/zfsonlinux/zfs/issues/2094
[issue 1911]: https://github.com/zfsonlinux/zfs/issues/1911
[issue 5256]: https://github.com/zfsonlinux/zfs/issues/5256
[issue 4083]: https://github.com/zfsonlinux/zfs/issues/4083

0 comments on commit 062dc68

Please sign in to comment.