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

Normalize similar arguments #752

Closed
SergioGasquez opened this issue Feb 7, 2025 · 1 comment · Fixed by #759
Closed

Normalize similar arguments #752

SergioGasquez opened this issue Feb 7, 2025 · 1 comment · Fixed by #759
Assignees
Labels
CLI Issues relating to the command-line interface
Milestone

Comments

@SergioGasquez
Copy link
Member

SergioGasquez commented Feb 7, 2025

erase-region takes two arguments:

Usage: espflash erase-region [OPTIONS] <OFFSET> <SIZE>

Arguments:
  <OFFSET>
          Offset to start erasing from

  <SIZE>
          Size of the region to erase
Options:

read-flash takes arguments:

Usage: espflash read-flash [OPTIONS] <OFFSET> <SIZE> <FILE>

Arguments:
  <OFFSET>
          Offset to start reading from

  <SIZE>
          Size of the region to read

  <FILE>
          Name of binary dump

checksum-md5 takes to required options:

Usage: espflash checksum-md5 [OPTIONS] --address <ADDRESS> --length <LENGTH>

Options:
  -a, --address <ADDRESS>
          Start address

  -l, --length <LENGTH>
          Length

Also, names of the same thing are different.

We should also look for other places where this migth occur

@SergioGasquez SergioGasquez self-assigned this Feb 7, 2025
@github-project-automation github-project-automation bot moved this to Todo in esp-rs Feb 7, 2025
@SergioGasquez SergioGasquez added this to the v4 milestone Feb 7, 2025
@jessebraham jessebraham added the CLI Issues relating to the command-line interface label Feb 7, 2025
@SergioGasquez
Copy link
Member Author

We should also rename some arguments to be consistent:

  • There are commands where we use addr and others where we use address
  • There are commands where we use elf and other where we use image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI Issues relating to the command-line interface
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants