Skip to content

Commit 38876af

Browse files
Refactor preview flag to be more clear (#134)
***NO_CI***
1 parent a800bf6 commit 38876af

File tree

3 files changed

+14
-15
lines changed

3 files changed

+14
-15
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,12 @@ nanoff --target ST_STM32F769I_DISCOVERY --deploy --image "E:\GitHub\nf-Samples\s
184184

185185
### Update the firmware of a ST_STM32F769I_DISCOVERY along with a managed application
186186

187-
To update the firmware of the ST_STM32F769I_DISCOVERY target to the latest available preview version, using a JTAG connection, along with a managed application.
187+
To update the firmware of the ST_STM32F769I_DISCOVERY target to the latest available version, using a JTAG connection, along with a managed application.
188188
You have to specify the path to the managed application.
189189
This example uses the binary format file that is generated by Visual Studio when building any nanoFramework C# application. Because it's a binary file you have to specify too the flash address of the deployment region (here 0x08000000, mind the hexadecimal format).
190190

191191
```console
192-
nanoff --update --target ST_STM32F769I_DISCOVERY --preview --jtag --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x08000000
192+
nanoff --update --target ST_STM32F769I_DISCOVERY --jtag --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x08000000
193193
```
194194

195195
### List all STM32 devices available with JTAG connection
@@ -297,21 +297,21 @@ Available COM ports:
297297

298298
## List targets
299299

300-
You can list the supported targets, their versions, either for stable versions or preview. `--platform` allows you to filter for a platform. `--preview` filters the query to show only preview versions.
300+
You can list the supported targets, and their version using the `--platform` parameter.
301301

302-
List packages available for ESP32 targets in preview version.
302+
List packages available for ESP32 targets:
303303

304304
```console
305-
nanoff --listboards --platform esp32 --preview
305+
nanoff --listboards --platform esp32
306306
```
307307

308-
List packages available for STM32 targets in (stable version).
308+
List packages available for STM32 targets:
309309

310310
```console
311311
nanoff --listboards --platform stm32
312312
```
313313

314-
If you just use `--listtargets` switch, you'll get the list of all the stable packages for all targets.
314+
If you use the `--listtargets` switch in conjunction with `--preview`, you'll get the list of packages that maybe used for experimental or major feature changes.
315315

316316
## Clear cache location
317317

README.zh-cn.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ nanoff --target ST_STM32F769I_DISCOVERY --deploy --image "E:\GitHub\nf-Samples\s
184184
本例使用了Visual Studio在构建任何nanoFramework c#应用程序时生成的二进制格式文件。 因为它是一个二进制文件,所以您还必须指定部署区域的flash地址(这里是0x08000000,注意十六进制格式)。
185185

186186
```控制台
187-
nanoff --update --target ST_STM32F769I_DISCOVERY --preview --jtag --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x08000000
187+
nanoff --update --target ST_STM32F769I_DISCOVERY --jtag --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x08000000
188188
```
189189

190190
### 列出JTAG连接中可用的所有STM32设备
@@ -264,12 +264,12 @@ nanoff -v q
264264
## 目标列表
265265

266266
翻译结果
267-
您可以列出支持的目标及其版本,用于稳定版本或预览。 `--platform` 允许您过滤平台。 `--preview` 过滤查询以仅显示预览版本。
267+
您可以列出支持的目标及其版本,用于稳定版本或预览。 `--platform` 允许您过滤平台。
268268

269269
在预览版本中列出可用于ESP32目标的软件包。
270270

271271
```控制台
272-
nanoff --listboards --platform esp32 --preview
272+
nanoff --listboards --platform esp32
273273
```
274274

275275
列出可用于STM32目标的包(稳定版本)。

nanoFirmwareFlasher/Options.cs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ public class Options
234234
"preview",
235235
Required = false,
236236
Default = false,
237-
HelpText = "Preview version. Will download the firmware package from the preview repository.")]
237+
HelpText = "Download a firmware package from the preview repository that includes major changes or experimental features.")]
238238
public bool Preview { get; set; }
239239

240240
[Option(
@@ -306,14 +306,13 @@ public class Options
306306
public static IEnumerable<Example> Examples =>
307307
new List<Example>
308308
{
309-
new("- Update ESP32 WROVER Kit device with latest available firmware (stable version)", new Options { TargetName = "ESP_WROVER_KIT", Update = true }),
310-
new("- Update specific STM32 device (ST_STM32F769I_DISCOVERY) with latest available firmware (preview version), using JTAG interface", new Options { TargetName = "ST_STM32F769I_DISCOVERY" , Update = true, Preview = true, JtagUpdate = true}),
309+
new("- Update ESP32 WROVER Kit device with latest available firmware", new Options { TargetName = "ESP_WROVER_KIT", Update = true }),
310+
new("- Update specific STM32 device (ST_STM32F769I_DISCOVERY) with latest available firmware, using JTAG interface", new Options { TargetName = "ST_STM32F769I_DISCOVERY" , Update = true, JtagUpdate = true}),
311311
new("- Update ESP32 device with latest available firmware (stable version), device is connected to COM31", new Options { TargetName = "ESP32_PSRAM_REV0", Update = true, SerialPort = "COM31" }),
312312
new("- Update ESP32 device with custom firmware (local bin file)", new Options { TargetName = "ESP_WROVER_KIT" , DeploymentImage = "<location of file>.bin"}),
313-
new("- Update specific STM32 device (NETDUINO3_WIFI) with latest available firmware (preview version), device is connected through DFU with Id 3380386D3134", new Options { TargetName = "NETDUINO3_WIFI", Update = true, Preview = true, DfuDeviceId = "3380386D3134" }),
314313
new("- List all STM32 devices connected through JTAG", new Options { Platform = SupportedPlatform.esp32, ListJtagDevices = true}),
315314
new("- Install STM32 JTAG drivers", new Options { InstallJtagDrivers = true}),
316-
new("- List all available STM32 targets", new Options { ListTargets = true, Preview = true, Platform = SupportedPlatform.stm32 }),
315+
new("- List all available STM32 targets", new Options { ListTargets = true, Platform = SupportedPlatform.stm32 }),
317316
new("- List all available COM ports", new Options { ListComPorts = true }),
318317
};
319318
}

0 commit comments

Comments
 (0)