Document deprecated fields in schema and correction to documentation

* Add deprecation comment to each of the deprecated fields * Fix SetupType to match new convention and documentation * Correct documentation as fields are already deprecated
brondani · Sep 5, 2022 · c9fcdcb · c9fcdcb
1 parent cb47b41
commit c9fcdcb
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 47 deletions.
diff --git a/tools/projmgr/docs/Manual/YML-Format.md b/tools/projmgr/docs/Manual/YML-Format.md
@@ -619,7 +619,7 @@ Control warnings (could be: no, all, Misra, AC5-like), mapped to the toolchain b
 
 ## `define:`
 
->**Note:** For a transition period `defines:` is also accepted.  However this will be deprecated.
+>**Note:** For a transition period `defines:` is also accepted.  However, this is deprecated and will be removed in a future update.
 
 Contains a list of symbol #define statements that are passed via the command line to the development tools.
 
@@ -638,7 +638,7 @@ define:                    # Start a list of define statements
 
 ## `undefine:`
 
->**Note:** For a transition period `undefines:` is also accepted.  However this will be deprecated.
+>**Note:** For a transition period `undefines:` is also accepted.  However, this is deprecated and will be removed in a future update.
 
 Remove symbol #define statements from the command line of the development tools.
 
@@ -662,7 +662,7 @@ groups:
 
 ## `add-path:`
 
->**Note:** For a transition period `add-paths:` is also accepted.  However this will be deprecated.
+>**Note:** For a transition period `add-paths:` is also accepted.  However, this is deprecated and will be removed in a future update.
 
 Add include paths to the command line of the development tools.
 
@@ -685,7 +685,7 @@ project:
 
 ## `del-path:`
 
->**Note:** For a transition period `del-paths:` is also accepted.  However this will be deprecated.
+>**Note:** For a transition period `del-paths:` is also accepted.  However, this is deprecated and will be removed in a future update.
 
 Remove include paths (that are defined at the cproject level) from the command line of the development tools.
 

diff --git a/tools/projmgr/schemas/common.schema.json b/tools/projmgr/schemas/common.schema.json
@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/schemas/projmgr/1.0.0/tools/projmgr/schemas/common.schema.json",
+  "$id": "https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/schemas/projmgr/1.0.1/tools/projmgr/schemas/common.schema.json",
   "title": "CMSIS Project Manager common",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "definitions": {
     "ArrayOfStrings": {
       "type": "array",
@@ -146,7 +146,7 @@
         "compiler":     { "$ref": "#/definitions/CompilerType" },
         "C":            { "$ref": "#/definitions/ArrayOfStrings", "description": "List of C flags" },
         "CPP":          { "$ref": "#/definitions/ArrayOfStrings", "description": "List of CPP flags" },
-        "C*":           { "$ref": "#/definitions/ArrayOfStrings", "description": "List of C & CPP flags" },
+        "C*":           { "$ref": "#/definitions/ArrayOfStrings", "description": "List of C & CPP flags (DEPRECATED use: C-CPP)"},
         "C-CPP":        { "$ref": "#/definitions/ArrayOfStrings", "description": "List of C & CPP flags" },
         "ASM":          { "$ref": "#/definitions/ArrayOfStrings", "description": "List of ASM flags"  },
         "Link":         { "$ref": "#/definitions/ArrayOfStrings", "description": "List of Linker flags" },
@@ -171,13 +171,13 @@
         "compiler":   { "$ref": "#/definitions/CompilerType" },
         "optimize":   { "$ref": "#/definitions/OptimizeType" },
         "debug":      { "$ref": "#/definitions/DebugType" },
-        "defines":    { "$ref": "#/definitions/DefinesType" },
+        "defines":    { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":     { "$ref": "#/definitions/DefinesType" },
-        "undefines":  { "$ref": "#/definitions/UndefinesType" },
+        "undefines":  { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":   { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":  { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":  { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":   { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":  { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":  { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":   { "$ref": "#/definitions/DelpathsType" },
         "misc":       { "$ref": "#/definitions/MiscTypes" }
       },
@@ -202,13 +202,13 @@
         "compiler":   { "$ref": "#/definitions/CompilerType" },
         "optimize":   { "$ref": "#/definitions/OptimizeType" },
         "debug":      { "$ref": "#/definitions/DebugType" },
-        "defines":    { "$ref": "#/definitions/DefinesType" },
+        "defines":    { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":     { "$ref": "#/definitions/DefinesType" },
-        "undefines":  { "$ref": "#/definitions/UndefinesType" },
+        "undefines":  { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":   { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":  { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":  { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":   { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":  { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":  { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":   { "$ref": "#/definitions/DelpathsType" },
         "misc":       { "$ref": "#/definitions/MiscTypes" }
       },
@@ -270,13 +270,13 @@
         "for-compiler": { "$ref": "#/definitions/CompilersType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
+        "defines":      { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":       { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
+        "undefines":    { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":     { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":    { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":     { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":    { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":     { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscTypes" },
         "groups":       { "$ref": "#/definitions/GroupsType" },
@@ -304,13 +304,13 @@
         "for-compiler": { "$ref": "#/definitions/CompilersType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
+        "defines":      { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":       { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
+        "undefines":    { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":     { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":    { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":     { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":    { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":     { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscTypes" }
       },
@@ -337,13 +337,13 @@
         "not-for-type": { "$ref": "#/definitions/NotForType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
+        "defines":      { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":       { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
+        "undefines":    { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":     { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":    { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":     { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":    { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":     { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscTypes" }
       },
@@ -367,13 +367,13 @@
         "not-for-type": { "$ref": "#/definitions/NotForType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
+        "defines":      { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":       { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
+        "undefines":    { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":     { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":    { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":     { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":    { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":     { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscType" }
       },
@@ -421,13 +421,13 @@
         "compiler":     { "$ref": "#/definitions/CompilerType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
+        "defines":      { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":       { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
+        "undefines":    { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":     { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":    { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":     { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":    { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":     { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscTypes" }
       },
@@ -445,13 +445,13 @@
         "optimize":    { "$ref": "#/definitions/OptimizeType" },
         "debug":       { "$ref": "#/definitions/DebugType" },
         "processor":   { "$ref": "#/definitions/ProcessorType" },
-        "defines":     { "$ref": "#/definitions/DefinesType" },
+        "defines":     { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":      { "$ref": "#/definitions/DefinesType" },
-        "undefines":   { "$ref": "#/definitions/UndefinesType" },
+        "undefines":   { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":    { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":   { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":   { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":    { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":   { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":   { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":    { "$ref": "#/definitions/DelpathsType" },
         "misc":        { "$ref": "#/definitions/MiscTypes" },
         "groups":      { "$ref": "#/definitions/GroupsType" },
@@ -474,13 +474,13 @@
         "optimize":    { "$ref": "#/definitions/OptimizeType" },
         "debug":       { "$ref": "#/definitions/DebugType" },
         "processor":   { "$ref": "#/definitions/ProcessorType" },
-        "defines":     { "$ref": "#/definitions/DefinesType" },
+        "defines":     { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
         "define":      { "$ref": "#/definitions/DefinesType" },
-        "undefines":   { "$ref": "#/definitions/UndefinesType" },
+        "undefines":   { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
         "undefine":    { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":   { "$ref": "#/definitions/AddpathsType" },
+        "add-paths":   { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
         "add-path":    { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":   { "$ref": "#/definitions/DelpathsType" },
+        "del-paths":   { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
         "del-path":    { "$ref": "#/definitions/DelpathsType" },
         "misc":        { "$ref": "#/definitions/MiscTypes" },
         "groups":      { "$ref": "#/definitions/GroupsType" },
@@ -528,10 +528,14 @@
         "for-compiler": { "$ref": "#/definitions/CompilersType" },
         "optimize":     { "$ref": "#/definitions/OptimizeType" },
         "debug":        { "$ref": "#/definitions/DebugType" },
-        "defines":      { "$ref": "#/definitions/DefinesType" },
-        "undefines":    { "$ref": "#/definitions/UndefinesType" },
-        "add-paths":    { "$ref": "#/definitions/AddpathsType" },
-        "del-paths":    { "$ref": "#/definitions/DelpathsType" },
+        "defines":     { "$ref": "#/definitions/DefinesType", "description": "DEPRECATED use: define" },
+        "define":      { "$ref": "#/definitions/DefinesType" },
+        "undefines":   { "$ref": "#/definitions/UndefinesType", "description": "DEPRECATED use: undefine" },
+        "undefine":    { "$ref": "#/definitions/UndefinesType" },
+        "add-paths":   { "$ref": "#/definitions/AddpathsType", "description": "DEPRECATED use: add-path" },
+        "add-path":    { "$ref": "#/definitions/AddpathsType" },
+        "del-paths":   { "$ref": "#/definitions/DelpathsType", "description": "DEPRECATED use: del-path" },
+        "del-path":    { "$ref": "#/definitions/DelpathsType" },
         "misc":         { "$ref": "#/definitions/MiscTypes" }
       },
       "$ref": "#/definitions/TypeListMutualExclusion",