Add copious amounts of markup

This commit is contained in:
Eric Torres 2019-04-23 16:46:08 -07:00
parent 1284a52b70
commit cc42fcdebe

View File

@ -10,31 +10,31 @@ Version 0.5.3
* rbackup.config.config_files * rbackup.config.config_files
* load_list_from_option() * .. function:: load_list_from_option()
* Use non-mutable default argument * Use non-mutable default argument
* Ensure that list is returned if fallback is unset * Ensure that list is returned if fallback is unset
* rbackup.struct.repository.Repository * rbackup.struct.repository.Repository
* Implement __eq__(), __ne__(), and __hash__() * Implement .. function:: __eq__(), .. function:: __ne__(), and .. function:: __hash__()
* Update docstrings explaining what happens to snapshot_symlink when snapshot is deleted * Update docstrings explaining what happens to snapshot_symlink when snapshot is deleted
* Building * Building
* Add sphinx build commands to setup.py * Add sphinx build commands to ``setup.py``
* Explain replacing colons on datetime on default snapshot name * Explain replacing colons on datetime on default snapshot name
* Project Structure * Project Structure
* Move config module to rbackup.config.config_files * Move config module to ``rbackup.config.config_files``
* Move config files to config_files/ in root dir * Move config files to ``config_files/`` in root dir
* Delete rbackup.plugins.pacman module * Delete ``rbackup.plugins.pacman`` module
Version 0.5.2 Version 0.5.2
------------- -------------
* Use try..finally blocks within context manager functions * Use ``try..finally`` blocks within context manager functions
Version 0.5.1 Version 0.5.1
------------- -------------
@ -52,33 +52,34 @@ Version 0.5
* rbackup.plugins.package_managers.PackageManager * rbackup.plugins.package_managers.PackageManager
* Raise NotimplementedError for non-supported operations * Raise ``NotimplementedError`` for non-supported operations
* rbackup.struct.hierarchy.Hierarchy * rbackup.struct.hierarchy.Hierarchy
* Move Repository.gen_metadata to Hierarchy._gen_metadata() * Move .. function:: Repository.gen_metadata to Hierarchy._gen_metadata()
* rbackup.struct.repository.Repository * rbackup.struct.repository.Repository
* Add basic logic for updating symlink after snapshot removal * Add basic logic for updating symlink after snapshot removal
* Implement snapshot deletion using __delitem__() * Implement snapshot deletion using .. function:: __delitem__()
* Add basic logic for symlinking after snapshot removal * Add basic logic for symlinking after snapshot removal
* rbackup.struct.repository.Snapshot * rbackup.struct.repository.Snapshot
* Add attribute code to _gen_metadata * Add attribute code to .. function:: _gen_metadata()
* Add ctime attribute * Add ``ctime`` attribute
* Project structure * Project structure
* Add file for snapshot management script * Add file for snapshot management script
* Rename rbackup.package_managers package to rbackup.plugins * Rename ``rbackup.package_managers`` to ``rbackup.plugins``
Version 0.4.1 Version 0.4.1
------------- -------------
* backup script * backup script
* Change umask to 0000 when running backup * Change umask to ``0000`` when running backup
Version 0.4 Version 0.4
----------- -----------
@ -89,11 +90,11 @@ Version 0.4
* rbackup.config Folder * rbackup.config Folder
* Add [main] to default config file * Add ``[main]`` to default config file
* rbackup.config.config_files * rbackup.config.config_files
* Add load_list_from_option() * Add .. function:: load_list_from_option()
Version 0.3 Version 0.3
----------- -----------
@ -108,13 +109,13 @@ Version 0.3
* rbackup.struct.repository.Repository * rbackup.struct.repository.Repository
* Add gen_metadata() * Add .. function:: gen_metadata()
* Add symlink_snapshot() * Add .. function:: symlink_snapshot()
* Ignore PermissionError when creating snapshot symlink * Ignore ``PermissionError`` when creating snapshot symlink
* config_files * config_files
* Include /root in default paths * Include ``/root`` in default paths
* Split config file handling into its own module * Split config file handling into its own module
* Doctest cleanup * Doctest cleanup
@ -132,41 +133,41 @@ Version 0.2
* rbackup.config_files * rbackup.config_files
* Split etc-include and system-include config files * Split ``etc-include`` and ``system-include`` config files
* rbackup.package_managers.packagemanager.PackageManager * rbackup.package_managers.packagemanager.PackageManager
* Remove type and value checking * Remove type and value checking
* Add gen_db_archive() * Add .. function:: gen_db_archive()
* Check for valid compression mode before proceeding with gen_db_archive() * Check for valid compression mode before proceeding with .. function:: gen_db_archive()
* rbackup.struct.hierarchy.Hierarchy * rbackup.struct.hierarchy.Hierarchy
* Add metadata_path * Add ``metadata_path``
* Subclass os.PathLike * Subclass ``os.PathLike``
* Make write_metadata() an atomic operation * Make .. function:: write_metadata() an atomic operation
* Log metadata read/write operations * Log metadata read/write operations
* rbackup.struct.repository.Repository * rbackup.struct.repository.Repository
* Add cleanup() * Add .. function:: cleanup()
* Add is_valid_snapshot_name() * Add .. function:: is_valid_snapshot_name()
* Add gen_snapshot_path() * Add .. function:: gen_snapshot_path()
* Remove current_snapshot attribute * Remove current_snapshot attribute
* Implement __repr__ * Implement .. function:: __repr__()
* Use regex to parse user snapshot name input * Use regex to parse user snapshot name input
* Split snapshot metadata lists * Split snapshot metadata lists
* Change serialization backend from pickle to JSON * Change serialization backend from pickle to JSON
* Raise ValueError when snapshot name contains a '/' * Raise ``ValueError`` when snapshot name contains a '/'
* rbackup.struct.repository.Snapshot * rbackup.struct.repository.Snapshot
* Remove all attributes except for pkg_dir * Remove all attributes except for ``pkg_dir``
* Project structure * Project structure
* Do not ship test suite under rbackup package * Do not ship test suite under rbackup package
* Rename rbackup.hierarchy package to rbackup.struct * Rename ``rbackup.hierarchy`` package to ``rbackup.struct``
Version 0.1 Version 0.1
----------- -----------