Use shell blocks for readme - #697
Open
sipke wants to merge 3 commits into
Open
Conversation
added 3 commits
August 31, 2026 12:57
Use the markdown shell block instead of prepending $ to command so that users can copy the block, as supported in github and IDEs. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Use the markdown shell block instead of prepending $ to command so that users can copy the block, as supported in github and IDEs. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Multiple lines of text are concatenated so use a code block for the supported targets so they are on individual lines. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sipke
force-pushed
the
feature/use-shell-blocks-for-readme
branch
from
August 31, 2026 03:01
7505f98 to
a2f8934
Compare
arnopo
reviewed
Aug 31, 2026
| generic arm | ||
| zephyr | ||
|
|
||
| ``` |
Collaborator
There was a problem hiding this comment.
Nitpicking: the use of bullet here seems to me better. But ok to keep you update if you prefer it
cshilwant
reviewed
Aug 31, 2026
| available in the scripts directory. | ||
|
|
||
| To check your \<n\> commits in your git branch: | ||
| ``` |
There was a problem hiding this comment.
Suggested change
| ```shell |
better to keep it consistent across - .github/actions/build_ci/README.md?
| The check can be performed locally using the the gitlint command. | ||
|
|
||
| Run gitlint locally in your tree and branch where your patches have been committed: | ||
| ``` |
There was a problem hiding this comment.
same comment as https://github.com/OpenAMP/open-amp/pull/697/changes#r3899220268
arnopo
reviewed
Sep 1, 2026
| generic arm | ||
| zephyr | ||
|
|
||
| ``` |
Collaborator
There was a problem hiding this comment.
Nitpicking: the use of bullet here seems to me better. But ok to keep you update if you prefer it
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To address documentation issues
OpenAMP/openamp-docs#73
OpenAMP/openamp-docs#84
Update code blocks to not use prompt ($) on command line so that github and IDE copy button provides exact command line.