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

87 lines
1.4 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
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. IMPORTANT: this file is auto-generated by "setup.py build_api", do not edit!
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
=================
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.cache
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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.compress
docs/api: cleanup
2017-02-12 21:48:41 +00:00
:members: get_compressor, Compressor, CompressorBase
ran setup.py build_api
2016-01-23 19:52:04 +00:00
:undoc-members:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.fuse
update api.rst
2016-10-17 01:36:49 +00:00
:members:
:undoc-members:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.hashindex
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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.keymanager
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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: 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:
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
.. automodule:: borg.platform
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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.platform_linux
ran build_api
2017-02-12 21:33:08 +00:00
:members:
:undoc-members:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.remote
ran build_api
2017-02-12 21:33:08 +00:00
:members:
:undoc-members:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.repository
ran build_api
2017-02-12 21:33:08 +00:00
:members:
:undoc-members:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.shellpattern
ran build_api
2017-02-12 21:33:08 +00:00
:members:
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:
setup.py: build_api: sort file list for determinism
2017-02-12 21:36:24 +00:00
.. automodule:: borg.xattr
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: