From: Mark Clarkstone <hello@markclarkstone.co.uk>
Date: Tue, 5 Apr 2016 01:53:54 +0000 (+0100)
Subject: mdhelp: add markdown description for dvrentry tooltips: update channelname and channe... 
X-Git-Tag: v4.2.1~734
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ca63491365811b7be468792123f43af92031bc38;p=thirdparty%2Ftvheadend.git

mdhelp: add markdown description for dvrentry tooltips: update channelname and channel property descriptions to differentiate them
---

diff --git a/docs/class/dvrentry.md b/docs/class/dvrentry.md
new file mode 100644
index 000000000..646047b7b
--- /dev/null
+++ b/docs/class/dvrentry.md
@@ -0,0 +1,12 @@
+The DVR entry is used by Tvheadend to keep track of the upcoming, 
+finished and failed recordings.
+
+* Upcoming and currently recording entries remain in the 'Upcoming/ 
+Current Recordings' tab.
+* When a recording completes successfully the entry gets moved to the 
+'Finished recordings' tab.
+* When a recording fails or is aborted it gets moved to the 'Failed 
+recordings' tab.
+
+Some entry details are not available/incomplete until the recording 
+completes or fails, e.g. filesize, total data errors, etc.
diff --git a/src/dvr/dvr_db.c b/src/dvr/dvr_db.c
index 7ea22f1a7..cb3d038b2 100644
--- a/src/dvr/dvr_db.c
+++ b/src/dvr/dvr_db.c
@@ -2809,10 +2809,13 @@ dvr_entry_class_content_type_list(void *o, const char *lang)
   return m;
 }
 
+extern const char *tvh_doc_dvrentry_class[];
+
 const idclass_t dvr_entry_class = {
   .ic_class     = "dvrentry",
-  .ic_caption   = N_("DVR entry"),
+  .ic_caption   = N_("DVR Entry"),
   .ic_event     = "dvrentry",
+  .ic_doc       = tvh_doc_dvrentry_class,
   .ic_changed   = dvr_entry_class_changed,
   .ic_save      = dvr_entry_class_save,
   .ic_get_title = dvr_entry_class_get_title,
@@ -2903,7 +2906,7 @@ const idclass_t dvr_entry_class = {
       .type     = PT_STR,
       .id       = "channel",
       .name     = N_("Channel"),
-      .desc     = N_("The channel to be used/used for the recording."),
+      .desc     = N_("The channel name the entry will record from."),
       .set      = dvr_entry_class_channel_set,
       .get      = dvr_entry_class_channel_get,
       .rend     = dvr_entry_class_channel_rend,
@@ -2922,7 +2925,7 @@ const idclass_t dvr_entry_class = {
       .type     = PT_STR,
       .id       = "channelname",
       .name     = N_("Channel name"),
-      .desc     = N_("Name of channel used for the recording."),
+      .desc     = N_("Name of channel the entry recorded from."),
       .get      = dvr_entry_class_channel_name_get,
       .set      = dvr_entry_class_channel_name_set,
       .off      = offsetof(dvr_entry_t, de_channel_name),