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

Update link to headertool.py in boot.md #4269

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

movefasta
Copy link

No description provided.

@matejcik
Copy link
Contributor

while you're touching this, using this link would be a much better choice: https://github.com/trezor/trezor-firmware/blob/main/core/tools/README.md

@movefasta
Copy link
Author

while you're touching this, using this link would be a much better choice: https://github.com/trezor/trezor-firmware/blob/main/core/tools/README.md

Thank you. Yes, this is an excellent description of all the available tools that are presented in the repository. But in the documentation on the Boot Stages page, it is headertool.py that is specified, which corresponds to the context. I am not sure that other tools are appropriate there that are not directly related to the headers of the firmware parts.

Anyway now it's just a broken link in https://docs.trezor.io/trezor-firmware/core/misc/boot.html

@Hannsek Hannsek requested a review from matejcik October 30, 2024 19:40
@matejcik
Copy link
Contributor

it is headertool.py that is specified, which corresponds to the context

Linking to the source code of headertool does not make sense anymore because it's not what you run -- instead, you use the headertool command present in the poetry virtual environment. That's what the general README should be telling you, which is why I suggested linking to it.

Another option is just to remove the link altogether and just say that there's headertool command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🔎 Needs review
Development

Successfully merging this pull request may close these issues.

2 participants