Skip to content

Commit c7225d8

Browse files
committed
Update memory stats
1 parent fc6fd56 commit c7225d8

File tree

5 files changed

+14
-5
lines changed

5 files changed

+14
-5
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,4 @@ jobs:
123123
uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
124124
with:
125125
config: .github/memory_statistics_config.json
126-
check_against: docs/doxygen/include/size_table.html
126+
check_against: docs/doxygen/include/size_table.md

.github/workflows/memory_statistics.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
uses: actions/upload-artifact@v2
2020
with:
2121
name: size_table
22-
path: size_table.html
22+
path: size_table.md

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ score over 8. This library has also undergone both static code analysis from
1313
safety and data structure invariance through the
1414
[CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
1515

16-
See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/standard/coreHTTP/docs/doxygen/output/html/index.html#http_memory_requirements).
16+
See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
1717

1818
**coreHTTP v2.0.0 [source code](https://github.com/FreeRTOS/coreHTTP/tree/v2.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
1919

@@ -82,8 +82,17 @@ The AWS IoT Device SDK for Embedded C repository contains demos of using the HTT
8282
library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/http)
8383
on a POSIX platform. These can be used as reference examples for the library API.
8484

85-
## Generating documentation
85+
## Documentation
8686

87+
### Existing Documentation
88+
For pre-generated documentation, please see the documentation linked in the locations below:
89+
90+
| Location |
91+
| :-: |
92+
| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
93+
| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreHTTP/docs/doxygen/output/html/index.html) |
94+
95+
### Generating Documentation
8796
The Doxygen references were created using Doxygen version 1.8.20. To generate the
8897
Doxygen pages, please run the following command from the root of this repository:
8998

docs/doxygen/pages.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Feature of HTTP/1.1 not supported in this library:
1717
@section http_memory_requirements Memory Requirements
1818
@brief Memory requirements of the HTTP Client library.
1919

20-
@include{doc} size_table.html
20+
@include{doc} size_table.md
2121
*/
2222

2323
/**

0 commit comments

Comments
 (0)