Skip to content

Commit fd7213e

Browse files
...
1 parent 0e145cd commit fd7213e

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

devdoc/porting_guide.md

+16-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# How to Port the Azure IoT C SDK to Other Platforms
22

3-
This document shows how to port the C Shared utility library to
4-
platforms not supported out of the box.
5-
The C shared utility library is used by C SDKs like IoTHub client SDK and EventHub client SDK.
3+
This document shows how to port the C Shared Utility library to
4+
platforms that are not already supported.
5+
6+
The C Shared Utility library is used by C SDKs like IoTHub client SDK and EventHub client SDK.
7+
8+
This document does not provide specific guidance for how to compile the Azure IoT
9+
libraries on any specific system. Most newly targeted systems will not support CMake, which
10+
is the SDK's preferred build system, so it is likely that newly targeted systems
11+
will need to have a makefile or the equivalent created by hand.
612

713
## References
814

9-
###### Specifications
15+
- [TLS adapter architecture overview](tlsio_adapter_overview.md).
16+
- [TLS adapter implementers guide](tls_adapter_implementers_guide.md).
1017
- [threadapi and sleep adapter specification](threadapi_and_sleep_requirements.md)<br/>
1118
- [lock adapter specification](lock_requirements.md)<br/>
1219

@@ -28,15 +35,14 @@ The following sections describe each step in detail.
2835
### Step 1 &ndash; Include common porting files and headers
2936

3037
The common porting source files are found in the C shared utility library's
31-
`pal` directory. Include these three files:
38+
`pal` directory. Include these three files in your project:
3239
* `tlsio_adapter_common.c`
3340
* `tlsio_options.c`
3441
* `tickcounter.c`
3542

36-
The headers for the common porting files are found in the `pal` directory. Add these two
37-
paths to your project header include directories:
43+
The headers for the common porting files are found in the `pal` directory. Add this
44+
path to your project header include directories:
3845
* `pal/inc`
39-
* `pal/generic`
4046

4147

4248
### Step 2 &ndash; Implement the required platform functions
@@ -118,8 +124,8 @@ that you can modify for this purpose.
118124
The Azure IoT Hub requires secure communication over TLS. The Azure IoT SDK uses
119125
a layered architecture that makes it simple to implement TLS for new devices.
120126

121-
If you're curious about the layered architecture, it is discussed
122-
[in this overview](tlsio_adapter_overview.md).
127+
If you're curious about the layered architecture, it is discussed in
128+
[this overview](tlsio_adapter_overview.md).
123129

124130
Details of how to implement TLS communication are in
125131
[this implementers guide](tls_adapter_implementers_guide.md).

0 commit comments

Comments
 (0)