-
Notifications
You must be signed in to change notification settings - Fork 688
Fix the stlink binary path #1726
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
Conversation
LaszloLango
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
akosthekiss
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW, the reference to stlink build instructions, well, that's not working. That #build-from-sources deep-linking anchor is unnecessary (and should not be used as the readme of stlink might change over time).
targets/nuttx-stm32f4/README.md
Outdated
| git clone https://bitbucket.org/nuttx/apps.git | ||
| git clone https://github.com/texane/stlink.git | ||
| cd stlink | ||
| git checkout 3d24377c2878fc328fb09b67cdfbda529d209417 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I agree with this. Why do we have to fix stlink to a given hash? In the commit message you've mentioned that this saved us from the need for frequent updates to the readme. But what is changing so frequently in stlink that triggers updates here?
If we specify the hash here, we will have a "last known good version", for sure. But we lose any potential benefit from the development that happens on stlink master. And if we wanted to follow up on that then we had to update readme with new "last known good version" hashes over and over again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akosthekiss Okey, I agree with that. What do you want, just update the changed path for the binary, and that's all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I indeed suggest to limit the changes to section 5. The file path to the stlink binary is one thing. The other is the flashing instructions URL, where I'd suggest to link to the repository only, without the #build-from-sources (which does not exist).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated following your opinion.
c6ed550 to
81bdd20
Compare
akosthekiss
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than the stylistic comment, LGTM
targets/nuttx-stm32f4/README.md
Outdated
| Connect Mini-USB for power supply and connect Micro-USB for `NSH` console. | ||
|
|
||
| To configure `stlink` utility for flashing, follow the instructions [here](https://github.com/texane/stlink#build-from-sources). | ||
| To configure `stlink` utility for flashing, follow the instructions in the official Stlink repository [here](https://github.com/texane/stlink). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider this nitpicking, but why not put the link on "Stlink repository", why is "here" needed?
JerryScript-DCO-1.0-Signed-off-by: Levente Orban orbanl@inf.u-szeged.hu
Fix the Stlink path for the binary file. Add to checkout for a single commit hash, and we don't need to update the README all the time when something is changes.
JerryScript-DCO-1.0-Signed-off-by: Levente Orban orbanl@inf.u-szeged.hu