Skip to content

Commit a1aacf6

Browse files
committed
Fix broken documentation
1 parent 8e722e7 commit a1aacf6

File tree

2 files changed

+36
-5
lines changed

2 files changed

+36
-5
lines changed

docs/linux.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,12 +207,27 @@ For additional examples on using Kinesis Video Streams Java SDK and Kinesis Vid
207207

208208
##### Running C++ unit tests
209209

210-
**Note:** Please set the [credentials](https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp/blob/master/install-instructions-linux.md#setting-credentials-in-environment-variables) before running the unit tests.
210+
**Note:** Please set the credentials before running the unit tests:
211+
212+
```
213+
$ export AWS_ACCESS_KEY_ID=YourAccessKeyId
214+
$ export AWS_SECRET_ACCESS_KEY=YourSecretAccessKey
215+
optionally, set AWS_SESSION_TOKEN if integrating with temporary token and AWS_DEFAULT_REGION for the region other than us-west-2
216+
```
211217

212218
The executable for **unit tests** will be built as `./tst/producer_test` inside the `build` directory. Launch it and it will run the unit test and kick off dummy frame streaming.
213219

214-
##### Enabling verbose logs
215-
Define `HEAP_DEBUG` and `LOG_STREAMING` C-defines by uncommenting the appropriate lines in CMakeList.txt
220+
##### Running GStreamer Unit tests
221+
222+
**Note:** Please set the credentials before running the unit tests:
223+
224+
```
225+
$ export AWS_ACCESS_KEY_ID=YourAccessKeyId
226+
$ export AWS_SECRET_ACCESS_KEY=YourSecretAccessKey
227+
optionally, set AWS_SESSION_TOKEN if integrating with temporary token and AWS_DEFAULT_REGION for the region other than us-west-2
228+
```
229+
230+
The executable for **GStreamer unit tests** will be built as `./tst/gstkvsplugintest` inside the `build` directory. Launch it and it will run the unit test and kick off dummy frame streaming.
216231

217232
----
218233
##### How to configure logging for producer SDK sample applications.

docs/macos.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,28 @@ For additional examples on using Kinesis Video Streams Java SDK and Kinesis Vid
149149
##### [Kinesis Video Streams Android SDK](https://github.com/awslabs/aws-sdk-android-samples/tree/master/AmazonKinesisVideoDemoApp)
150150
-----
151151

152-
##### Running C++ Unit tests
152+
##### Running C++ unit tests
153153

154-
The executable for **unit tests** will be built as `./tst/producerTest` inside the `build` directory. Launch it and it will run the unit test and kick off dummy frame streaming.
154+
**Note:** Please set the credentials before running the unit tests:
155+
156+
```
157+
$ export AWS_ACCESS_KEY_ID=YourAccessKeyId
158+
$ export AWS_SECRET_ACCESS_KEY=YourSecretAccessKey
159+
optionally, set AWS_SESSION_TOKEN if integrating with temporary token and AWS_DEFAULT_REGION for the region other than us-west-2
160+
```
161+
162+
The executable for **unit tests** will be built as `./tst/producer_test` inside the `build` directory. Launch it and it will run the unit test and kick off dummy frame streaming.
155163

156164
##### Running GStreamer Unit tests
157165

166+
**Note:** Please set the credentials before running the unit tests:
167+
168+
```
169+
$ export AWS_ACCESS_KEY_ID=YourAccessKeyId
170+
$ export AWS_SECRET_ACCESS_KEY=YourSecretAccessKey
171+
optionally, set AWS_SESSION_TOKEN if integrating with temporary token and AWS_DEFAULT_REGION for the region other than us-west-2
172+
```
173+
158174
The executable for **GStreamer unit tests** will be built as `./tst/gstkvsplugintest` inside the `build` directory. Launch it and it will run the unit test and kick off dummy frame streaming.
159175

160176

0 commit comments

Comments
 (0)