mirror_zfs/contrib/pyzfs/docs/source/index.rst

.. pyzfs documentation master file, created by
   sphinx-quickstart on Mon Apr  6 23:48:40 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyzfs's documentation!
=================================

Contents:

.. toctree::
   :maxdepth: 2


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Documentation for the libzfs_core
*********************************

.. automodule:: libzfs_core
   :members:
   :exclude-members: lzc_snap, lzc_recv, lzc_destroy_one,
       lzc_inherit, lzc_set_props, lzc_list

Documentation for the libzfs_core exceptions
********************************************

.. automodule:: libzfs_core.exceptions
   :members:
   :undoc-members:

Documentation for the miscellaneous types that correspond to specific width C types
***********************************************************************************

.. automodule:: libzfs_core.ctypes
   :members:
   :undoc-members:
Import pyzfs source code from ClusterHQ libzfs_core is intended to be a stable interface for programmatic administration of ZFS. This wrapper provides one-to-one wrappers for libzfs_core API functions, but the signatures and types are more natural to Python. nvlists are wrapped as dictionaries or lists depending on their usage. Some parameters have default values depending on typical use for increased convenience. Enumerations and bit flags become strings and lists of strings in Python. Errors are reported as exceptions rather than integer errno-style error codes. The wrapper takes care to provide one-to-many mapping of the error codes to the exceptions by interpreting a context in which the error code is produced. Unit tests and automated test for the libzfs_core API are provided with this package. Please note that the API tests perform lots of ZFS dataset level operations and ZFS tries hard to ensure that any modifications do reach stable storage. That means that the operations are done synchronously and that, for example, disk caches are flushed. Thus, the tests can be very slow on real hardware. It is recommended to place the default temporary directory or a temporary directory specified by, for instance, TMP environment variable on a memory backed filesystem. Original-patch-by: Andriy Gapon <avg@FreeBSD.org> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Ported-by: loli10K <ezomori.nozomu@gmail.com> Signed-off-by: loli10K <ezomori.nozomu@gmail.com> Closes #7230 2018-03-03 13:10:34 +03:00			`.. pyzfs documentation master file, created by`
			`sphinx-quickstart on Mon Apr 6 23:48:40 2015.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

			`Welcome to pyzfs's documentation!`
			`=================================`

			`Contents:`

			`.. toctree::`
			`:maxdepth: 2`



			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`

			`Documentation for the libzfs_core`
			`*********************************`

			`.. automodule:: libzfs_core`
			`:members:`
			`:exclude-members: lzc_snap, lzc_recv, lzc_destroy_one,`
			`lzc_inherit, lzc_set_props, lzc_list`

			`Documentation for the libzfs_core exceptions`
			`********************************************`

			`.. automodule:: libzfs_core.exceptions`
			`:members:`
			`:undoc-members:`

			`Documentation for the miscellaneous types that correspond to specific width C types`
			`***********************************************************************************`

			`.. automodule:: libzfs_core.ctypes`
			`:members:`
			`:undoc-members:`