mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
borg/docs/api.rst

96 lines
1.6 KiB
ReStructuredText
Raw Normal View History

commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
API Documentation
=================
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.archiver
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.archive
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.repository
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.remote
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.cache
ran setup.py build_api
2016-01-23 19:52:04 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.key
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.nonces
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.item
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.constants
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.logger
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.helpers
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.locking
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.shellpattern
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.lrucache
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.fuse
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.selftest
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.xattr
:members:
:undoc-members:
.. automodule:: src.borg.platform.base
:members:
:undoc-members:
.. automodule:: src.borg.platform.linux
:members:
:undoc-members:
.. automodule:: src.borg.hashindex
:members:
:undoc-members:
.. automodule:: src.borg.compress
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
:members: get_compressor, Compressor, CompressorBase
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.chunker
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api, reorder as in 1.0
2016-08-27 22:16:19 +00:00
.. automodule:: src.borg.crypto
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members: