diff options
Diffstat (limited to 'browser/components/backup/docs')
| -rw-r--r-- | browser/components/backup/docs/backup-resources.rst | 18 | ||||
| -rw-r--r-- | browser/components/backup/docs/index.rst | 1 |
2 files changed, 19 insertions, 0 deletions
diff --git a/browser/components/backup/docs/backup-resources.rst b/browser/components/backup/docs/backup-resources.rst new file mode 100644 index 0000000000..4ead0d316d --- /dev/null +++ b/browser/components/backup/docs/backup-resources.rst @@ -0,0 +1,18 @@ +================================ +Backup Resources Reference +================================ + +A ``BackupResource`` is the base class used to represent a group of data within +a user profile that is logical to backup together. For example, the +``PlacesBackupResource`` represents both the ``places.sqlite`` SQLite database, +as well as the ``favicons.sqlite`` database. The ``AddonsBackupResource`` +represents not only the preferences for various addons, but also the XPI files +that those addons are defined in. + +Each ``BackupResource`` subclass is registered for use by the +``BackupService`` by adding it to the default set of exported classes in the +``BackupResources`` module in ``BackupResources.sys.mjs``. + +.. js:autoclass:: BackupResource + :members: + :private-members: diff --git a/browser/components/backup/docs/index.rst b/browser/components/backup/docs/index.rst index 1e201f8f1c..db9995dad2 100644 --- a/browser/components/backup/docs/index.rst +++ b/browser/components/backup/docs/index.rst @@ -11,3 +11,4 @@ into a single file that can be easily restored from. :maxdepth: 3 backup-service + backup-resources |