From fd8e3d3d0a757ebe21204fc9a8648d2828f31b2f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Lebleu?= <jerome.lebleu@mailoo.org>
Date: Thu, 6 Nov 2014 02:49:22 +0100
Subject: [PATCH] [enh] Add optionnal 'description' info to the backup archive

---
 actionsmap/yunohost.yml | 3 +++
 backup.py               | 5 ++++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/actionsmap/yunohost.yml b/actionsmap/yunohost.yml
index 9ba88bf8a..718114e12 100644
--- a/actionsmap/yunohost.yml
+++ b/actionsmap/yunohost.yml
@@ -571,6 +571,9 @@ backup:
                         pattern:
                             - '^[\w\-\.]{1,30}(?<!\.)$'
                             - pattern_backup_archive_name
+                -d:
+                    full: --description
+                    help: Short description of the backup
                 --ignore-apps:
                     help: Do not backup apps
                     action: store_true
diff --git a/backup.py b/backup.py
index 7445c3e34..577ec083e 100644
--- a/backup.py
+++ b/backup.py
@@ -40,12 +40,13 @@ archives_path = '%s/archives' % backup_path
 logger = getActionLogger('yunohost.backup')
 
 
-def backup_create(name=None, ignore_apps=False):
+def backup_create(name=None, description=None, ignore_apps=False):
     """
     Create a backup local archive
 
     Keyword arguments:
         name -- Name of the backup archive
+        description -- Short description of the backup
         ignore_apps -- Do not backup apps
 
     """
@@ -61,6 +62,7 @@ def backup_create(name=None, ignore_apps=False):
 
     # Initialize backup info
     info = {
+        'description': description or '',
         'created_at': timestamp,
         'apps': {},
     }
@@ -286,5 +288,6 @@ def backup_info(name):
         'path': archive_file,
         'created_at': time.strftime(m18n.n('format_datetime_short'),
                                     time.gmtime(info['created_at'])),
+        'description': info['description'],
         'apps': info['apps'],
     }