From: E.Smith <31170571+azlm8t@users.noreply.github.com>
Date: Fri, 8 Sep 2017 18:43:27 +0000 (+0100)
Subject: eit: Add additional documentation on EIT scraper. (#4578)
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5afd22d4febc5161924fc86df7213589dabe7129;p=thirdparty%2Ftvheadend.git

eit: Add additional documentation on EIT scraper. (#4578)

Add some more documentation on the EIT scraper to clarify
that it does not access the Internet and that we only ship
with a few configurations at the moment.

Issue: #4578
---

diff --git a/docs/class/epggrabber_modules.md b/docs/class/epggrabber_modules.md
index d51fa3dd5..c7739d181 100644
--- a/docs/class/epggrabber_modules.md
+++ b/docs/class/epggrabber_modules.md
@@ -31,3 +31,32 @@ to the grabber that provides you with richer data.
 **Tip**: Don't forget to set the *EIT time offset* for your network(s).
 
 ---
+
+### OTA Scrapper
+
+Some OTA EIT grabber mechanisms support additional scraping options.
+
+The OTA broadcast data often does not have specific dedicated fields
+to describe the programme season, episode, etc. Sometimes this
+information is included in the programme summary.
+
+The scraper configuration files contains regular expressions to scrape
+additional information from the broadcast information.  For example
+the broadcast summary may include the text '(S10 E5)' and the
+configuration file will extract this.
+
+This scraping option does not access or retrieve details from the
+Internet.
+
+Currently only a limited number of configuration files are shipped and
+these are located in the epggrab/eit/scrape directory.
+
+If the "EIT: DVB Grabber" is used then typically you would enter the
+configuration file (such as "uk") and enable relevant tickboxes to
+enable the additional scraping.
+
+If the scraper configuration is not enabled then the default behaviour
+means broadcast information such as summary information will still be
+retrieved.
+
+---
diff --git a/src/epggrab/module.c b/src/epggrab/module.c
index 41ad6d25f..a37d2cdbf 100644
--- a/src/epggrab/module.c
+++ b/src/epggrab/module.c
@@ -253,7 +253,9 @@ const idclass_t epggrab_mod_ota_scraper_class = {
       .id     = "scrape_config",
       .name   = N_("Scraper configuration to use"),
       .desc   = N_("Configuration containing regular expressions to use for "
-                   "scraping information from the broadcast guide. "
+                   "scraping additional information from the broadcast guide."
+                   "This option does not access or retrieve details from the "
+                   "Internet."
                    "This can be left blank to use the default or "
                    "set to one of the Tvheadend configurations from the "
                    "epggrab/eit/scrape directory such as "