Mirrors_Framework/open-amp
1
0
Fork 0
mirror of https://github.com/OpenAMP/open-amp.git synced 2026-10-02 18:23:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

github actions:README: use shell block for commands in Markdown files

Browse Source 
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>
This commit is contained in:
Sipke Vriend
2026-09-09 19:10:47 +02:00
committed by Arnaud Pouliquen
parent bb45852c58
commit c0359e4ae5
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/actions/build_ci/README.md
+5 -5
View File
@@ -30,12 +30,12 @@ This should be cleaned up in a future PR.
Desktop testing is possible but is likewise messy right now. Desktop testing is possible but is likewise messy right now.
One time setup, starting in open-amp directory: One time setup, starting in open-amp directory:
``` ```shell
$ git clone https://github.com/OpenAMP/libmetal.git git clone https://github.com/OpenAMP/libmetal.git
``` ```
A sequence like below will work, change the "zephyr" at the end of the docker command line to "linux" or "generic" for the other working tests A sequence like below will work, change the "zephyr" at the end of the docker command line to "linux" or "generic" for the other working tests
``` ```shell
$ docker build -t openamp-ci .github/actions/build_ci/ && docker run -it --rm -v$PWD:/prj -w /prj openamp-ci zephyr docker build -t openamp-ci .github/actions/build_ci/ && docker run -it --rm -v$PWD:/prj -w /prj openamp-ci zephyr
$ sudo rm -rf build* zephyr* sudo rm -rf build* zephyr*
``` ```
README.md
+3 -3
View File
@@ -148,7 +148,7 @@ instead of the full license text in the individual files:
### Signed-off-by ### Signed-off-by
Commit message must contain Signed-off-by: line and your email must match the change authorship Commit message must contain Signed-off-by: line and your email must match the change authorship
information. Make sure your .gitconfig is set up correctly: information. Make sure your .gitconfig is set up correctly:
``` ```shell
git config --global user.name "first-name Last-Namer" git config --global user.name "first-name Last-Namer"
git config --global user.email "yourmail@company.com" git config --global user.email "yourmail@company.com"
``` ```
@@ -175,7 +175,7 @@ Before you submit a pull request to the project, verify your commit messages mee
The check can be performed locally using the the gitlint command. 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: Run gitlint locally in your tree and branch where your patches have been committed:
``` ```shell
gitlint gitlint
``` ```
Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or
@@ -191,7 +191,7 @@ The Linux kernel GPL-licensed tool checkpatch is used to check coding style conf
available in the scripts directory. available in the scripts directory.
To check your \<n\> commits in your git branch: To check your \<n\> commits in your git branch:
``` ```shell
./scripts/checkpatch.pl --strict -g HEAD-<n> ./scripts/checkpatch.pl --strict -g HEAD-<n>
``` ```
### Send a pull request ### Send a pull request