Release cleanup (#104)

Updates version numbers, README.md documentation links, and adds C++ guards in core_json.h.
FreeRTOS · Jul 23, 2021 · caf540c · caf540c
1 parent 9066f2c
commit caf540c
Show file tree

Hide file tree

Showing 35 changed files with 64 additions and 33 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -113,4 +113,4 @@ jobs:
         uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
         with:
             config: .github/memory_statistics_config.json
-            check_against: docs/doxygen/include/size_table.html
+            check_against: docs/doxygen/include/size_table.md
diff --git a/.github/workflows/memory_statistics.yml b/.github/workflows/memory_statistics.yml
@@ -19,4 +19,4 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: size_table
-          path: size_table.html
+          path: size_table.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log for coreJSON Library
 
+## v3.0.2 (July 2021)
+- [#100](https://github.com/FreeRTOS/coreJSON/pull/100) Fix overflow in skipOneHexEscape().
+- [#95](https://github.com/FreeRTOS/coreJSON/pull/95) Eliminate warnings when base char type is unsigned.
+- [#93](https://github.com/FreeRTOS/coreJSON/pull/93) Wrap query key separator macro with ifndef.
+
 ## v3.0.1 (February 2021)
  - [#86](https://github.com/FreeRTOS/coreJSON/pull/86) Fix MISRA 9.1 violation.
  - [#84](https://github.com/FreeRTOS/coreJSON/pull/84), [#82](https://github.com/FreeRTOS/coreJSON/pull/82) and [#80](https://github.com/FreeRTOS/coreJSON/pull/80) Documentation updates and fixes.

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This repository contains the coreJSON library, a parser that strictly enforces t
 
 This library has gone through code quality checks including verification that no function has a [GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html) score over 8, and checks against deviations from mandatory rules in the [MISRA coding standard](https://www.misra.org.uk). Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviations](MISRA.md). This library has also undergone both static code analysis from [Coverity static analysis](https://scan.coverity.com/), and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
 
-See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/standard/coreJSON/docs/doxygen/output/html/index.html#json_memory_requirements).
+See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
 
 **coreJSON v3.0.0 [source code](https://github.com/FreeRTOS/coreJSON/tree/v3.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
 
@@ -68,7 +68,19 @@ gcc -I source/include example.c source/core_json.c -o example
 gcc -I source/include -c source/core_json.c
 ```
 
-## Generating documentation
+## Documentation
+
+### Existing documentation
+For pre-generated documentation, please see the documentation linked in the locations below:
+
+| Location |
+| :-: |
+| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
+| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreJSON/docs/doxygen/output/html/index.html) |
+
+Note that the latest included version of the coreJSON library may differ across repositories.
+
+### Generating documentation
 
 The Doxygen references were created using Doxygen version 1.8.20. To generate the
 Doxygen pages, please run the following command from the root of this repository:

diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "coreJSON"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v3.0.1"
+PROJECT_NUMBER         = "v3.0.2"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/docs/doxygen/include/size_table.html → docs/doxygen/include/size_table.md b/docs/doxygen/include/size_table.html → docs/doxygen/include/size_table.md
diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox
@@ -12,7 +12,7 @@ and no heap allocation, making it suitable for IoT microcontrollers, but also fu
 @section json_memory_requirements Memory Requirements
 @brief Memory requirements of the JSON library.
 
-@include{doc} size_table.html
+@include{doc} size_table.md
 
 @section json_design Design
 @brief JSON Library Design

diff --git a/lexicon.txt b/lexicon.txt
@@ -64,6 +64,7 @@ keylength
 len
 longjmp
 mainpage
+md
 microcontrollers
 min
 misra

diff --git a/manifest.yml b/manifest.yml
@@ -1,5 +1,5 @@
 name : "coreJSON"
-version: "v3.0.1"
+version: "v3.0.2"
 description: |
   "A parser strictly enforcing the ECMA-404 JSON standard, suitable for microcontrollers. \n"
 license: "MIT"
diff --git a/source/core_json.c b/source/core_json.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/source/include/core_json.h b/source/include/core_json.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -31,6 +31,12 @@
 #include <stdbool.h>
 #include <stddef.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /**
  * @ingroup json_enum_types
  * @brief Return codes from coreJSON library functions.
@@ -321,4 +327,11 @@ JSONStatus_t JSON_Iterate( const char * buf,
                            size_t * next,
                            JSONPair_t * outPair );
 /* @[declare_json_iterate] */
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef CORE_JSON_H_ */
diff --git a/test/cbmc/include/core_json_annex.h b/test/cbmc/include/core_json_annex.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/skipGeneric.h b/test/cbmc/include/skipGeneric.h
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Iterate/JSON_Iterate_harness.c b/test/cbmc/proofs/JSON_Iterate/JSON_Iterate_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Search/JSON_Search_harness.c b/test/cbmc/proofs/JSON_Search/JSON_Search_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/JSON_Validate/JSON_Validate_harness.c b/test/cbmc/proofs/JSON_Validate/JSON_Validate_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipAnyLiteral/skipAnyLiteral_harness.c b/test/cbmc/proofs/skipAnyLiteral/skipAnyLiteral_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipCollection/skipCollection_harness.c b/test/cbmc/proofs/skipCollection/skipCollection_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipEscape/skipEscape_harness.c b/test/cbmc/proofs/skipEscape/skipEscape_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipNumber/skipNumber_harness.c b/test/cbmc/proofs/skipNumber/skipNumber_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipSpace/skipSpace_harness.c b/test/cbmc/proofs/skipSpace/skipSpace_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipSpaceAndComma/skipSpaceAndComma_harness.c b/test/cbmc/proofs/skipSpaceAndComma/skipSpaceAndComma_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipString/skipString_harness.c b/test/cbmc/proofs/skipString/skipString_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/skipUTF8/skipUTF8_harness.c b/test/cbmc/proofs/skipUTF8/skipUTF8_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipAnyLiteral.c b/test/cbmc/stubs/skipAnyLiteral.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipAnyScalar.c b/test/cbmc/stubs/skipAnyScalar.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipCollection.c b/test/cbmc/stubs/skipCollection.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipEscape.c b/test/cbmc/stubs/skipEscape.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipGeneric.c b/test/cbmc/stubs/skipGeneric.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipNumber.c b/test/cbmc/stubs/skipNumber.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipSpace.c b/test/cbmc/stubs/skipSpace.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipSpaceAndComma.c b/test/cbmc/stubs/skipSpaceAndComma.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipString.c b/test/cbmc/stubs/skipString.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/skipUTF8.c b/test/cbmc/stubs/skipUTF8.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/unit-test/core_json_utest.c b/test/unit-test/core_json_utest.c
@@ -1,5 +1,5 @@
 /*
- * coreJSON v3.0.1
+ * coreJSON v3.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of