Merge ~info-martin-konrad/epics-base:deprecation-warning-state-record into ~epics-core/epics-base/+git/epics-base:7.0

[Martin Konrad]

Rebased on 7.0.

[Andrew Johnson (anj)]

I would prefer that this go into the 7.0 branch; we aren't going to remove the state record from any 3.15 release and probably not from a 7.0 release, but I could see it going from 7.1. In any case it will need an entry in the Release Notes too.

[Martin Konrad (info-martin-konrad)]

I have updated the message to say the record will be removed in 7.1 - these details might save users some research.

Note that according to https://github.com/epics-base/epics-base/blob/3.15/src/std/rec/stateRecord.dbd.pod this record is deprecated even in 3.15. As a 3.15 user I would appreciate a warning like this - rather than silently running into surprises after upgrading to 7.1. Let me know if you still prefer to merge this into the 7.0 branch.

[Andrew Johnson (anj)]

That doc warning was only added at the Documentathon (last September, so not really "for a while") when we de-wikified the record reference docs, and it was more to scare people away from using the event record type in new databases than to actually flag that it was about to be deleted. I wouldn't have actually removed it until after lots of warning in the release notes. The disadvantage with putting this in 3.15 and the 3.15 release notes is that when they get merged up to 7.0 the release entries about 3.15 changes appear somewhere towards the middle of the release document, not at the top, so it will actually be less visible than if you were to make the change directly on the 7.0 branch.

[Martin Konrad (info-martin-konrad)]

I improved the formatting of the message as discussed during our code review earlier today.

[Andrew Johnson (anj)]

Group Review 2020-03-25: Approve.

review: Approve

[mdavidsaver (mdavidsaver)]

Cherry picked as fd5edce919ba5a24469faf28d3453086a3ac4df1

diff --git a/documentation/RELEASE_NOTES.md b/documentation/RELEASE_NOTES.md
index 2adeacf..4bd4297 100644
--- a/documentation/RELEASE_NOTES.md
+++ b/documentation/RELEASE_NOTES.md
@@ -12,6 +12,12 @@ The external PVA submodules each have their own separate set of release notes
 which should also be read to understand what has changed since an earlier
 release.
 
+### `state` record deprecated
+
+IOCs now emit a warning when a database file containing the `state` record is
+loaded. This record has been deprecated for a while and will be removed
+beginning with EPICS 7.1. Consider using the `stringin` record instead.
+
 ## EPICS Release 7.0.3.1
 
 **IMPORTANT NOTE:** *Some record types in this release will not be compatible
diff --git a/modules/database/src/std/rec/stateRecord.c b/modules/database/src/std/rec/stateRecord.c
index fd5b9fb..78eee99 100644
--- a/modules/database/src/std/rec/stateRecord.c
+++ b/modules/database/src/std/rec/stateRecord.c
@@ -28,6 +28,7 @@
 #include "errMdef.h"
 #include "recSup.h"
 #include "recGbl.h"
+#include "errlog.h"
 
 #define GEN_SIZE_OFFSET
 #include "stateRecord.h"
@@ -37,7 +38,7 @@
 /* Create RSET - Record Support Entry Table*/
 #define report NULL
 #define initialize NULL
-#define init_record NULL
+static long init_record(struct dbCommon *prec, int pass);
 static long process(struct dbCommon *);
 #define special NULL
 #define get_value NULL
@@ -77,6 +78,19 @@ epicsExportAddress(rset,stateRSET);
 
 static void monitor(stateRecord *);
 

+static long init_record(struct dbCommon *prec, int pass)
+{
+    if(pass == 0) {
+        errlogPrintf(
+            "WARNING: Using deprecated record type \"state\" for record "
+            "\"%s\".\nThis record type will be removed beginning with EPICS "
+            "7.1. Please replace it\nby a stringin record.\n",
+            prec->name
+        );
+    }
+    return 0;
+}
+
 static long process(struct dbCommon *pcommon)
 {
     struct stateRecord *prec = (struct stateRecord *)pcommon;