From: mpmc <git@markclarkstone.co.uk>
Date: Sat, 2 Dec 2017 23:04:20 +0000 (+0000)
Subject: mdhelp: add ignore_path property doc
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ddb3d498f4c5144cfda9eea8fbf30b5dc5f147e4;p=thirdparty%2Ftvheadend.git

mdhelp: add ignore_path property doc
---

diff --git a/docs/property/ignore_path.md b/docs/property/ignore_path.md
new file mode 100644
index 000000000..f59ab461d
--- /dev/null
+++ b/docs/property/ignore_path.md
@@ -0,0 +1,16 @@
+\n
+By default all URLs (in a playlist) with path component changes are treated as new services. 
+This causes channels linked to them to be marked ```{name-not-set}``` 
+due to the previously-used URL "no longer existing" in the playlist, they in fact do exist but have changed slightly.
+
+Setting a number here forces tvheadend to ignore frequently-changing 
+path components when deciding if a URL is new or not - starting from the end of the URL..
+
+Here are some examples:-
+
+URL in playlist                                                 | Frequently changing path component(s) in URL   | Number of components to ignore | Treated as new if changed?                            
+----------------------------------------------------------------|------------------------------------------------|--------------------------------|-----------------------------------------------------
+```http://ip.tv/channel/BBC1/id/dHZoZWFkZW5kLm9yZw==```         | ```dHZoZWFkZW5kLm9yZw==```                     | 0                              | Yes, because no components are ignored.
+```http://ip.tv/channel/BBC1/id/dHZoZWFkZW5kLm9yZw==```         | ```dHZoZWFkZW5kLm9yZw==```                     | 1                              | No, because we're ignoring the last component ```dHZoZWFkZW5kLm9yZw==```.
+```http://ip.tv/channel/BBC4/id/dHZoZWFkZW5kLm9yZw==/1234```    | ```dHZoZWFkZW5kLm9yZw==``` / ```1234```        | 1                              | Yes, but only if the second-from-last component ```dHZoZWFkZW5kLm9yZw==``` changes. We're ignoring the last component ```1234```, so if that changes it won't make any difference.
+```http://ip.tv/channel/BBC4/id/dHZoZWFkZW5kLm9yZw==/1234```    | ```dHZoZWFkZW5kLm9yZw==``` / ```1234```        | 2                              | No, because we're ignoring the last two components ```dHZoZWFkZW5kLm9yZw==```/```1234```.
diff --git a/src/input/mpegts/iptv/iptv.c b/src/input/mpegts/iptv/iptv.c
index ae8881b09..d04b54058 100644
--- a/src/input/mpegts/iptv/iptv.c
+++ b/src/input/mpegts/iptv/iptv.c
@@ -848,6 +848,8 @@ iptv_auto_network_class_charset_list(void *o, const char *lang)
   return m;
 }
 
+PROP_DOC(ignore_path)
+
 const idclass_t iptv_auto_network_class = {
   .ic_super      = &iptv_network_class,
   .ic_class      = "iptv_auto_network",
@@ -878,7 +880,7 @@ const idclass_t iptv_auto_network_class = {
       .intextra = CHANNEL_SPLIT,
       .id       = "channel_number",
       .name     = N_("Channel numbers from"),
-      .desc     = N_("Lowest starting channel number."),
+      .desc     = N_("Lowest starting channel number (when mapping). "),
       .off      = offsetof(iptv_network_t, in_channel_number),
     },
     {
@@ -902,6 +904,7 @@ const idclass_t iptv_auto_network_class = {
       .type     = PT_BOOL,
       .id       = "tsid_zero",
       .name     = N_("Accept zero value for TSID"),
+      .desc     = N_("Accept transport ID if zero."),
       .off      = offsetof(iptv_network_t, in_tsid_accept_zero_value),
     },
     {
@@ -931,9 +934,10 @@ const idclass_t iptv_auto_network_class = {
       .name     = N_("Ignore path components"),
       .desc     = N_("Ignore last components in path. The defined count "
                      "of last path components separated by / are removed "
-                     "when the identical source is compared."),
+                     "when the identical source is compared - see Help for a detailed explanation."),
+      .doc      = prop_doc_ignore_path,
       .off      = offsetof(iptv_network_t, in_ignore_path),
-      .def.s    = "",
+      .def.s    = 0,
       .opts     = PO_EXPERT
     },
     {}