Update CHANGELOG, version numbers, and add C++ header guards (#53)

* Update CHANGELOG, version numbers, and add C++ header guards * Update memory stats
aws · Jul 22, 2021 · 9a69e7d · 9a69e7d
1 parent 4200d92
commit 9a69e7d
Show file tree

Hide file tree

Showing 24 changed files with 51 additions and 22 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -98,4 +98,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 @@
 # Changelog for AWS IoT Jobs Library
 
+## v1.1.1 (July 2021)
+
+### API Changes:
+- [#50](https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk/pull/50) Move declaration of temporary variables after length check
+
 ## v1.1.0 (March 2021)
 
 ### API Changes:

diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Deviations](MISRA.md). This library has also undergone both static code
 analysis from [Coverity](https://scan.coverity.com/), and validation of
 memory safety with the [CBMC bounded model checker](https://www.cprover.org/cbmc/).
 
-See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/jobs-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html#jobs_memory_requirements).
+See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
 
 **AWS IoT Jobs  v1.1.0 [source code](https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk/tree/v1.1.0/source) is part of the [FreeRTOS 202012.01 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) release.**
 
@@ -46,8 +46,19 @@ The AWS IoT Device SDK for Embedded C repository contains a demo using
 the jobs library on a POSIX platform.
 https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/jobs/jobs_demo_mosquitto
 
-## 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/jobs-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) |
+
+Note that the latest included version of the AWS IoT Jobs 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           = "AWS IoT Jobs"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v1.1.0"
+PROJECT_NUMBER         = "v1.1.1"
 
 # 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
@@ -20,7 +20,7 @@ It has proofs showing safe memory use and no heap allocation, making it suitable
 @section jobs_memory_requirements Memory Requirements
 @brief Memory requirements of the jobs library.
 
-@include{doc} size_table.html
+@include{doc} size_table.md
  */
 
 /**

diff --git a/lexicon.txt b/lexicon.txt
@@ -65,6 +65,7 @@ jobsupdatesuccess
 longjmp
 mainpage
 malloc
+md
 microcontrollers
 misra
 mqtt

diff --git a/manifest.yml b/manifest.yml
@@ -1,5 +1,5 @@
 name : "Jobs-for-AWS-IoT-embedded-sdk"
-version: "v1.1.0"
+version: "v1.1.1"
 description: |
   "Library for using the AWS IoT Jobs service on embedded devices.\n"
 license: "MIT"
diff --git a/source/include/jobs.h b/source/include/jobs.h
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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
@@ -33,6 +33,12 @@
 #include <stddef.h>
 #include <stdint.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /**
  * @ingroup jobs_constants
  * @brief Maximum length of a thing name for the AWS IoT Jobs Service.
@@ -734,4 +740,10 @@ JobsStatus_t Jobs_Update( char * buffer,
                           size_t * outLength );
 /* @[declare_jobs_update] */
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef JOBS_H_ */
diff --git a/source/jobs.c b/source/jobs.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/jobs_annex.h b/test/cbmc/include/jobs_annex.h
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_Describe/Jobs_Describe_harness.c b/test/cbmc/proofs/Jobs_Describe/Jobs_Describe_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_GetPending/Jobs_GetPending_harness.c b/test/cbmc/proofs/Jobs_GetPending/Jobs_GetPending_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_GetTopic/Jobs_GetTopic_harness.c b/test/cbmc/proofs/Jobs_GetTopic/Jobs_GetTopic_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_MatchTopic/Jobs_MatchTopic_harness.c b/test/cbmc/proofs/Jobs_MatchTopic/Jobs_MatchTopic_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_StartNext/Jobs_StartNext_harness.c b/test/cbmc/proofs/Jobs_StartNext/Jobs_StartNext_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/Jobs_Update/Jobs_Update_harness.c b/test/cbmc/proofs/Jobs_Update/Jobs_Update_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/strnAppend/strnAppend_harness.c b/test/cbmc/proofs/strnAppend/strnAppend_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/strnEq/strnEq_harness.c b/test/cbmc/proofs/strnEq/strnEq_harness.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/strnAppend.c b/test/cbmc/stubs/strnAppend.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/strnEq.c b/test/cbmc/stubs/strnEq.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/catch_assert.h b/test/unit-test/catch_assert.h
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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/jobs_utest.c b/test/unit-test/jobs_utest.c
@@ -1,5 +1,5 @@
 /*
- * AWS IoT Jobs v1.1.0
+ * AWS IoT Jobs v1.1.1
  * 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
-Original file line number
+Diff line change
@@ Expand Up / @@ -65,6 +65,7 @@ jobsupdatesuccess @@
     longjmp
     mainpage
     malloc
+    md
     microcontrollers
     misra
     mqtt
@@ Expand Down @@