Skip to content

docs: fix shell prompts in TPM 2 PKCS#11 validation example - #944

Merged
kprosise merged 1 commit into
foundriesio:mainfrom
caiotpereira:lmp-98
Oct 27, 2026
Merged

kprosise merged 1 commit into
foundriesio:mainfrom
caiotpereira:lmp-98

Conversation

@caiotpereira

Copy link
Copy Markdown
Contributor

Two lines in the validation code-block were missing the $ prompt prefix used by every other command in the block. Also make the PTOOL definition an explicit alias so the snippet works when copy-pasted into an interactive shell.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.
You may delete items that are not relevant to your contribution.
Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

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

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck, and add redirects for any moved or deleted pages.
  • 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

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Two lines in the validation code-block were missing the `$` prompt
prefix used by every other command in the block. Also make the PTOOL
definition an explicit `alias` so the snippet works when copy-pasted
into an interactive shell.

Signed-off-by: Caio Pereira <caiopere@qti.qualcomm.com>
@caiotpereira
caiotpereira requested a review from kprosise October 14, 2026 14:53

@kprosise kprosise left a comment

Copy link
Copy Markdown
Contributor

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 341de01 into foundriesio:main Oct 27, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants