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.

Sign up for GitHub

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

Jump to bottom

rm: Fix lsusb command in some NXP boards flashing instruction #632

Merged
merged 1 commit into from
Dec 6, 2023
Merged

rm: Fix lsusb command in some NXP boards flashing instruction #632

merged 1 commit into from
Dec 6, 2023

Conversation

detsch
Copy link
Member

@detsch detsch commented Nov 30, 2023 •
edited
Loading

In some cases, the command itself was missing the first letter on the rendered html ("susb" instead of "lsusb"). In others, the command output was missing the first letter ("us 002 Device 052..." instead of "Bus 002 Device 052...").

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

The instructions for flashing some NXP boards in the rendered HTMLs where missing the first char in some cases. This PR fixes it.

I've verified the generated HTMLs and grepped for all cases where this was happening, fixing them all.

Checklist

Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

@detsch
rm: Fix lsusb command in some NXP boards flashing instruction
6aee75f 
In some cases, the command itself was missing the first letter on the
rendered html ("susb" instead of "lsusb"). In others, the command output
was missing the first letter ("us 002 Device 052..." instead of "Bus
002 Device 052...").

Signed-off-by: Andre Detsch <andre.detsch@foundries.io>
@doanac
Copy link
Member

doanac commented Nov 30, 2023

Docs for 6aee75f are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2498/docs/artifacts/html/index.html

kprosise
kprosise approved these changes Nov 30, 2023
View reviewed changes
Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kprosise kprosise merged commit 41546f0 into foundriesio:main Dec 6, 2023
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kprosise kprosise kprosise approved these changes

@angolini angolini Awaiting requested review from angolini

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@detsch @doanac @kprosise