Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating .script, .upgrade and .exit commands help text #36

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading