From e75676de33c8187b29b57c8c194b4329709ce93d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 7 Jan 2020 11:16:30 +0100 Subject: [PATCH] docs/UPGRADING.md: Clarify the kaleidoscope::Runtime parts Fixes #788. Signed-off-by: Gergely Nagy --- docs/UPGRADING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 57ccbb41..fadc0ac4 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -529,7 +529,10 @@ Older versions of the plugin required one to set up `Key_Redial` manually, and l ### Class/global instance Kaleidoscope_/Kaleidoscope renamed to kaleidoscope::Runtime_/kaleidoscope::Runtime -After renaming, some of the original symbols have been deprecated. The deprecated symbols in `kaleidoscope/Runtime.h` are scheduled for removal on **2019-03-10**. +After the renaming, Kaleidoscope core should be using `kaleidoscope::Runtime`. +The former `Kaleidoscope` global symbol is to be used by sketches only - and +only because to not diverge too much from the Arduino naming style. Deprecated +symbols are scheduled for removal on **2020-03-15**. ### Transition to linear indexing