Skip to content
This repository was archived by the owner on Oct 12, 2023. It is now read-only.

Commit cea7199

Browse files
committed
Some documentation needs to be updated because we moved v1 to "v1"
directory.
1 parent fc59fdd commit cea7199

File tree

5 files changed

+30
-30
lines changed

5 files changed

+30
-30
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ Feature requests can be filed at https://feedback.azure.com/forums/907045-azure-
3030
## Directory structure
3131
The second version of Azure IoT Edge is in public preview. We intend to open source the code when the product enters general availability and will place the code here.
3232

33-
### v1
33+
### [v1](v1/README.md)
3434
This folder contains the Azure IoT Edge V1 codebase. V1 will continue to be supported. V1 documentation which used to live on docs.microsoft.com has been moved along side the code in this folder. Bugs can continue to be filed on the issues section of this repo.

v1/samples/hello_world/iot-hub-linux-iot-edge-get-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ You can now build the IoT Edge runtime and samples on your local machine:
4848
1. Run the build script as follows:
4949

5050
```sh
51-
tools/build.sh --disable-native-remote-modules
51+
v1/tools/build.sh --disable-native-remote-modules
5252
```
5353

54-
This script uses the **cmake** utility to create a folder called **build** in the root folder of your local copy of the **iot-edge** repository and generate a makefile. The script then builds the solution, skipping unit tests and end to end tests. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
54+
This script uses the **cmake** utility to create a folder called **v1/build** in the root folder of your local copy of the **iot-edge** repository and generate a makefile. The script then builds the solution, skipping unit tests and end to end tests. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
5555

5656
> [!NOTE]
57-
> Every time you run the **build.sh** script, it deletes and then recreates the **build** folder in the root folder of your local copy of the **iot-edge** repository.
57+
> Every time you run the **build.sh** script, it deletes and then recreates the **v1/build** folder in the root folder of your local copy of the **iot-edge** repository.
5858

5959
## How to run the sample
6060

61-
The **build.sh** script generates its output in the **build** folder in your local copy of the **iot-edge** repository. This output includes the two IoT Edge modules used in this sample.
61+
The **build.sh** script generates its output in the **v1/build** folder in your local copy of the **iot-edge** repository. This output includes the two IoT Edge modules used in this sample.
6262

63-
The build script places **liblogger.so** in the **build/modules/logger/** folder and **libhello\_world.so** in the **build/modules/hello_world/** folder. Use these paths for the **module path** values as shown in the example JSON settings file.
63+
The build script places **liblogger.so** in the **v1/build/modules/logger/** folder and **libhello\_world.so** in the **v1/build/modules/hello_world/** folder. Use these paths for the **module path** values as shown in the example JSON settings file.
6464

6565
The hello\_world\_sample process takes the path to a JSON configuration file as a command-line argument. The following example JSON file is provided in the SDK repository at **samples/hello\_world/src/hello\_world\_lin.json**. This configuration file works as is unless you modify the build script to place the IoT Edge modules or sample executables in non-default locations.
6666

@@ -102,7 +102,7 @@ The hello\_world\_sample process takes the path to a JSON configuration file as
102102
}
103103
```
104104

105-
1. Navigate to the **build** folder in the root of your local copy of the **iot-edge** repository.
105+
1. Navigate to the **v1/build** folder in the root of your local copy of the **iot-edge** repository.
106106

107107
1. Run the following command:
108108

v1/samples/hello_world/iot-hub-windows-iot-edge-get-started.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,19 @@ You can now build the IoT Edge runtime and samples on your local machine:
4747
1. Run the build script as follows:
4848
4949
```cmd
50-
tools\build.cmd --disable-native-remote-modules
50+
v1\tools\build.cmd --disable-native-remote-modules
5151
```
5252
53-
This script creates a Visual Studio solution file and builds the solution. You can find the Visual Studio solution in the **build** folder in your local copy of the **iot-edge** repository. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
53+
This script creates a Visual Studio solution file and builds the solution. You can find the Visual Studio solution in the **v1\build** folder in your local copy of the **iot-edge** repository. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
5454
5555
> [!NOTE]
56-
> Every time you run the **build.cmd** script, it deletes and then recreates the **build** folder in the root folder of your local copy of the **iot-edge** repository.
56+
> Every time you run the **build.cmd** script, it deletes and then recreates the **v1\build** folder in the root folder of your local copy of the **iot-edge** repository.
5757
5858
## Run the sample
5959
60-
The **build.cmd** script generates its output in the **build** folder in your local copy of the **iot-edge** repository. This output includes many files, but this sample focuses on three:
61-
- Two IoT Edge modules: **build\\modules\\logger\\Debug\\logger.dll** and **build\\modules\\hello_world\\Debug\\hello\_world.dll**.
62-
- An executable file: **build\\samples\\hello\_world\\Debug\\hello\_world\_sample.exe**. This process takes a JSON configuration file as a command-line argument.
60+
The **build.cmd** script generates its output in the **v1\build** folder in your local copy of the **iot-edge** repository. This output includes many files, but this sample focuses on three:
61+
- Two IoT Edge modules: **v1\\build\\modules\\logger\\Debug\\logger.dll** and **v1\\build\\modules\\hello_world\\Debug\\hello\_world.dll**.
62+
- An executable file: **v1\\build\\samples\\hello\_world\\Debug\\hello\_world\_sample.exe**. This process takes a JSON configuration file as a command-line argument.
6363
6464
The fourth file that you use in this sample isn't in the build folder, but was included when you cloned it iot-edge repository:
6565
- A JSON configuration file: **samples\\hello\_world\\src\\hello\_world\_win.json**. This file contains the paths to the two modules. It also declares where logger.dll writes its output to. The default is **log.txt** in your current working directory.
@@ -69,7 +69,7 @@ The fourth file that you use in this sample isn't in the build folder, but was i
6969
7070
To run the sample, follow these steps:
7171
72-
1. Navigate to the **build** folder in the root of your local copy of the **iot-edge** repository.
72+
1. Navigate to the **v1\build** folder in the root of your local copy of the **iot-edge** repository.
7373
7474
1. Run the following command:
7575

v1/samples/simulated_device_cloud_upload/iot-hub-linux-iot-edge-simulated-device.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,21 +51,21 @@ You can now build the IoT Edge runtime and samples on your local machine:
5151
tools/build.sh --disable-native-remote-modules
5252
```
5353

54-
This script uses the **cmake** utility to create a folder called **build** in the root folder of your local copy of the **iot-edge** repository and generate a makefile. The script then builds the solution, skipping unit tests and end to end tests. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
54+
This script uses the **cmake** utility to create a folder called **v1/build** in the root folder of your local copy of the **iot-edge** repository and generate a makefile. The script then builds the solution, skipping unit tests and end to end tests. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
5555

5656
> [!NOTE]
57-
> Every time you run the **build.sh** script, it deletes and then recreates the **build** folder in the root folder of your local copy of the **iot-edge** repository.
57+
> Every time you run the **build.sh** script, it deletes and then recreates the **v1/build** folder in the root folder of your local copy of the **iot-edge** repository.
5858

5959
## How to run the sample
6060

61-
The **build.sh** script generates its output in the **build** folder in your local copy of the **iot-edge** repository. This output includes the four IoT Edge modules used in this sample.
61+
The **build.sh** script generates its output in the **v1/build** folder in your local copy of the **iot-edge** repository. This output includes the four IoT Edge modules used in this sample.
6262

6363
The build script places the:
6464

65-
* **liblogger.so** in the **build/modules/logger** folder.
66-
* **libiothub.so** in the **build/modules/iothub** folder.
67-
* **lib\_identity\_map.so** in the **build/modules/identitymap** folder.
68-
* **libsimulated\_device.so** in the **build/modules/simulated\_device** folder.
65+
* **liblogger.so** in the **v1/build/modules/logger** folder.
66+
* **libiothub.so** in the **v1/build/modules/iothub** folder.
67+
* **lib\_identity\_map.so** in the **v1/build/modules/identitymap** folder.
68+
* **libsimulated\_device.so** in the **v1/build/modules/simulated\_device** folder.
6969

7070
Use these paths for the **module path** values as shown in the following JSON settings file:
7171

@@ -80,7 +80,7 @@ In a text editor, open the file **samples/simulated\_device\_cloud\_upload\_samp
8080
* The **mapping** module maps the MAC addresses of your simulated devices to your IoT Hub device ids. Make sure that **deviceId** values match the ids of the two devices you added to your IoT hub, and that the **deviceKey** values contain the keys of your two devices.
8181
* The **BLE1** and **BLE2** modules are the simulated devices. Note how their MAC addresses match the addresses in the **mapping** module.
8282
* The **Logger** module logs your gateway activity to a file.
83-
* The **module path** values shown in the example assume that you run the sample from the **build** folder in your local copy of the **iot-edge** repository.
83+
* The **module path** values shown in the example assume that you run the sample from the **v1/build** folder in your local copy of the **iot-edge** repository.
8484
* The **links** array at the bottom of the JSON file connects the **BLE1** and **BLE2** modules to the **mapping** module, and the **mapping** module to the **IoTHub** module. It also ensures that all messages are logged by the **Logger** module.
8585

8686
```json

v1/samples/simulated_device_cloud_upload/iot-hub-windows-iot-edge-simulated-device.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,21 @@ You can now build the IoT Edge runtime and samples on your local machine:
5050
tools\build.cmd --disable-native-remote-modules
5151
```
5252
53-
This script creates a Visual Studio solution file and builds the solution. You can find the Visual Studio solution in the **build** folder in your local copy of the **iot-edge** repository. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
53+
This script creates a Visual Studio solution file and builds the solution. You can find the Visual Studio solution in the **v1\build** folder in your local copy of the **iot-edge** repository. If you want to build and run the unit tests, add the `--run-unittests` parameter. If you want to build and run the end to end tests, add the `--run-e2e-tests`.
5454
5555
> [!NOTE]
56-
> Every time you run the **build.cmd** script, it deletes and then recreates the **build** folder in the root folder of your local copy of the **iot-edge** repository.
56+
> Every time you run the **build.cmd** script, it deletes and then recreates the **v1\build** folder in the root folder of your local copy of the **iot-edge** repository.
5757
5858
## Run the sample
5959
60-
The **build.cmd** script generates its output in the **build** folder in your local copy of the **iot-edge** repository. This output includes the four IoT Edge modules used in this sample.
60+
The **build.cmd** script generates its output in the **v1\build** folder in your local copy of the **iot-edge** repository. This output includes the four IoT Edge modules used in this sample.
6161
6262
The build script creates the following files:
6363
64-
* **logger.dll** in the **build\\modules\\logger\\Debug** folder.
65-
* **iothub.dll** in the **build\\modules\\iothub\\Debug** folder.
66-
* **identity\_map.dll** in the **build\\modules\\identitymap\\Debug** folder.
67-
* **simulated\_device.dll** in the **build\\modules\\simulated\_device\\Debug** folder.
64+
* **logger.dll** in the **v1\\build\\modules\\logger\\Debug** folder.
65+
* **iothub.dll** in the **v1\\build\\modules\\iothub\\Debug** folder.
66+
* **identity\_map.dll** in the **v1\\build\\modules\\identitymap\\Debug** folder.
67+
* **simulated\_device.dll** in the **v1\\build\\modules\\simulated\_device\\Debug** folder.
6868
6969
Use these paths for the **module path** values as shown in the simulated\_device\_cloud\_upload\_win JSON settings file.
7070
@@ -173,7 +173,7 @@ Save the changes you made to the configuration file.
173173

174174
To run the sample:
175175

176-
1. At a command prompt, navigate to the **build** folder in your local copy of the **iot-edge** repository.
176+
1. At a command prompt, navigate to the **v1\build** folder in your local copy of the **iot-edge** repository.
177177
2. Run the following command:
178178

179179
```cmd

0 commit comments

Comments
 (0)