Difference between revisions of "Documentation"

From OpenZFS
Jump to navigation Jump to search
Line 28: Line 28:
''Do we want this here or should this just be part of the links to other distributions?''
''Do we want this here or should this just be part of the links to other distributions?''


== Implementation Documentation aimed at developers ==
== [[Resources | Implementation Documentation for Developers]]
* Architectural/high-level documentation about general OpenZFS concepts
** [[Documentation/ZfsSend|ZFS Send]]
** [[Documentation/Administrative Commands | Administrative Commands]] (e.g. <code>zfs snapshot -r pool/fs@snap</code>)
 
Links to documentation on other websites:
 
* The ZFS [http://maczfs.googlecode.com/files/ZFSOnDiskFormat.pdf On-Disk Format] document is a good overview, although sorely out of date
* The [http://java.net/projects/solaris-zfs/pages/Sourcetour source tour] describes the various subcomponents in ZFS.
* Blog posts on specific ZFS features
** [https://blogs.oracle.com/ahrens/entry/is_it_magic snapshots]
** [https://blogs.oracle.com/ahrens/entry/new_scrub_code scrub/resilver]
** [https://blogs.oracle.com/perrin/entry/the_lumberjack ZIL] (ZFS Intent Log)
** [https://blogs.oracle.com/bonwick/entry/space_maps space maps] and [https://blogs.oracle.com/bonwick/en_US/entry/zfs_block_allocation block allocation]
** [https://blogs.oracle.com/eschrock/entry/zfs_hot_spares Hot spares]
** [https://blogs.oracle.com/bonwick/en_US/entry/zfs_dedup Deduplication]
** [https://blogs.oracle.com/bonwick/en_US/entry/raid_z RAID-Z]
** [http://mirror-admin.blogspot.com/2011/12/how-l2arc-works.html L2ARC]
 
== Repo-Specific Developer Documentation ==
* Information about how to develop ZFS for the different distributions/pointers to them (e.g., how to build illumos)
** In particular, documentation about how to test and possibly scripts for building
** Needs to be written/links provided by reps from those communities

Revision as of 23:50, 13 September 2013

General Documentation aimed at users / system administrators

Distribution-Specific User Documentation

FreeBSD

Gentoo

Other

  • Links to user documentation (distribution)

Do we want this here or should this just be part of the links to other distributions?

== Implementation Documentation for Developers