From 4372d55dd118b259817a2eb6474ebf5c5f7c3ae7 Mon Sep 17 00:00:00 2001
From: Klaus Schmidinger <vdr@tvdr.de>
Date: Sat, 24 Dec 2022 11:37:17 +0100
Subject: [PATCH] Added a note to epg.h about not messing with event ids

---
 CONTRIBUTORS | 1 +
 HISTORY      | 3 ++-
 epg.h        | 5 +++--
 3 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
index 30338f3e..ce083f4a 100644
--- a/CONTRIBUTORS
+++ b/CONTRIBUTORS
@@ -2806,6 +2806,7 @@ Winfried K
  for adding some missing "AUTO" values to vdr.5
  for fixing default values for DVB-T
  for adding missing rounding when dividing frequencies in processing the NIT
+ for suggesting to add note about not messing with event ids in EPG handlers
 
 Hans-Werner Hilse <hilse@web.de>
  for adding the command line option --userdump to enable core dumps in case VDR
diff --git a/HISTORY b/HISTORY
index 3a7bc9cb..7f4494d1 100644
--- a/HISTORY
+++ b/HISTORY
@@ -9833,9 +9833,10 @@ Video Disk Recorder Revision History
 - Avoiding a zero sized array in cDevice::GetDevice() (thanks to Marko Mäkelä).
 - Now checking the video directory after setting the user id.
 
-2022-12-23:
+2022-12-24:
 
 - Updated the Italian OSD texts (thanks to Diego Pierotto).
 - Fixed restoring the volume at program start (thanks to Matthias Senzel).
 - Fixed symmetry of Begin/EndSegmentTransfer() calls in cEIT::cEIT() (thanks to
   Jörg Wendel).
+- Added a note to epg.h about not messing with event ids (suggested by Winfried Köhler).
diff --git a/epg.h b/epg.h
index e4689251..d8c08fd2 100644
--- a/epg.h
+++ b/epg.h
@@ -7,7 +7,7 @@
  * Original version (as used in VDR before 1.3.0) written by
  * Robert Schneider <Robert.Schneider@web.de> and Rolf Hakenes <hakenes@hippomi.de>.
  *
- * $Id: epg.h 5.2 2021/04/28 20:44:56 kls Exp $
+ * $Id: epg.h 5.3 2022/12/24 11:37:17 kls Exp $
  */
 
 #ifndef __EPG_H
@@ -274,6 +274,7 @@ public:
           ///< therefore the EPG handlers have to take care of this. Otherwise the parsing of
           ///< non-updates will waste a lot of resources.
   virtual bool SetEventID(cEvent *Event, tEventID EventID) { return false; }
+          ///< Important note: if you want VPS to work, do not mess with the event ids!
   virtual bool SetTitle(cEvent *Event, const char *Title) { return false; }
   virtual bool SetShortText(cEvent *Event, const char *ShortText) { return false; }
   virtual bool SetDescription(cEvent *Event, const char *Description) { return false; }
@@ -298,7 +299,7 @@ public:
           ///< Designed to give handlers the possibility to prepare a database transaction.
           ///< If any EPG handler returns false in this function, it is assumed that
           ///< the EPG for the given Channel has to be handled later due to some transaction problems,
-          ///> therefore the processing will aborted.
+          ///> therefore the processing will be aborted.
           ///< Dummy is for backward compatibility and may be removed in a future version.
   virtual bool EndSegmentTransfer(bool Modified, bool Dummy) { return false; } // TODO remove obsolete Dummy
           ///< Called after the segment data has been processed.