Skip to content

Commit

Permalink
Updating .script, .upgrade and .exit commands help text (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
jharajeev55 authored Oct 8, 2024
1 parent 45a98ae commit 458e854
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 14 deletions.
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
Security -- in case of vulnerabilities.
-->

## [0.18.3]

### Changed

- .script , .upgrade and .exit commands descriptions updated

## [0.18.2]

### Fixed
Expand Down Expand Up @@ -137,7 +143,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
- Feature to retrieve TSP-Link network details

<!--Version Comparison Links-->
[Unreleased]: https://github.com/tektronix/tsp-toolkit-kic-cli/compare/v0.18.1...HEAD
[Unreleased]: https://github.com/tektronix/tsp-toolkit-kic-cli/compare/v0.18.3...HEAD
[0.18.3]: https://github.com/tektronix/tsp-toolkit-kic-cli/releases/tag/v0.18.3
[0.18.2]: https://github.com/tektronix/tsp-toolkit-kic-cli/releases/tag/v0.18.2
[0.18.1]: https://github.com/tektronix/tsp-toolkit-kic-cli/releases/tag/v0.18.1
[0.18.0]: https://github.com/tektronix/tsp-toolkit-kic-cli/releases/tag/v0.18.0
[0.17.0]: https://github.com/tektronix/tsp-toolkit-kic-cli/releases/tag/v0.17.0
Expand Down
10 changes: 5 additions & 5 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ members = [
resolver = "2"

[workspace.package]
version = "0.18.2"
version = "0.18.3"
authors = ["Keithley Instruments, LLC"]
edition = "2021"
repository = "https://github.com/tektronix/tsp-toolkit-kic-cli"
Expand Down
12 changes: 8 additions & 4 deletions instrument-repl/src/repl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -465,14 +465,16 @@ impl Repl {
.subcommand_required(false)
.help_template(CMD_TEMPLATE)
.subcommand(
Command::new(".script").about("Send a script to the connected instrument")
Command::new(".script").about("Send a TSP script to the connected instrument")
.help_template(SUBCMD_TEMPLATE)
.disable_help_flag(true)
.arg(
Arg::new("help").short('h').long("help").help("Print help").action(ArgAction::SetTrue)
)
.arg(
Arg::new("path").required_unless_present("help")
Arg::new("path")
.required_unless_present("help")
.help("Path to the TSP script file to be sent to the instrument")
)
)
.subcommand(
Expand All @@ -486,7 +488,9 @@ impl Repl {
arg!(-s --slot <SLOT_NUM> "Collect information of a specific slot (if applicable) instead of the mainframe").value_parser(value_parser!(u16))
)
.arg(
Arg::new("path").required_unless_present("help")
Arg::new("path")
.required_unless_present("help")
.help("Path to the firmware file to be sent to the instrument")
)
)
.subcommand(
Expand All @@ -498,7 +502,7 @@ impl Repl {
.subcommand(
Command::new(".exit")
.alias(".quit").help_template(SUBCMD_TEMPLATE)
.about("Exit the application")
.about("Disconnect from instrument and close terminal")
.disable_help_flag(true)
.arg(
Arg::new("help").short('h').long("help").help("Print help").action(ArgAction::SetTrue)
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@tektronix/kic-cli",
"version": "0.18.0",
"version": "0.18.3",
"main": "index.js",
"bin": {
"windows-kic": "./bin/kic.exe",
Expand Down

0 comments on commit 458e854

Please sign in to comment.