From ec524103b0fd910a6cd82f0b86fc9164940660ff Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 31 Aug 2026 09:57:05 +1000 Subject: [PATCH 1/3] github actions:README: add some new lines and code block for clarity Multiple lines of text are concatenated so use a code block for the supported targets and example usage so they are on individual lines. Signed-off-by: Sipke Vriend --- .github/actions/build_ci/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/actions/build_ci/README.md b/.github/actions/build_ci/README.md index 098c7bdb5..1998d9687 100644 --- a/.github/actions/build_ci/README.md +++ b/.github/actions/build_ci/README.md @@ -7,15 +7,20 @@ This action test builds for a specified target. ### `target` **Required** the build target. Default `"linux"`. + The supported targets are: +``` linux generic arm freertos zephyr +``` ## Example usage +``` uses: ./.github/actions/build_ci with: - target: freertos \ No newline at end of file + target: freertos +``` From 4a105d40900eefc0feeab6be67140ef855c11568 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 31 Aug 2026 09:56:53 +1000 Subject: [PATCH 2/3] README: use shell block for commands in Markdown files 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 --- README.md | 55 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 23313bd6d..fd19a0c32 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,12 @@ in cmake command line to disable the option. ## Build Steps ### Building for Linux Host -``` - $ git clone https://github.com/OpenAMP/libmetal.git - $ mkdir -p libmetal/ - $ cd libmetal/ - $ cmake .. - $ make VERBOSE=1 DESTDIR= install +```shell +git clone https://github.com/OpenAMP/libmetal.git +mkdir -p libmetal/ +cd libmetal/ +cmake .. +make VERBOSE=1 DESTDIR= install ``` ### Cross Compiling for Linux Target @@ -69,11 +69,11 @@ example toolchain file: ``` * Note: other toolchain files can be found in the `cmake/platforms/` directory. * Compile with your toolchain file. -``` - $ mkdir -p build-libmetal - $ cd build-libmetal - $ cmake -DCMAKE_TOOLCHAIN_FILE= - $ make VERBOSE=1 DESTDIR= install +```shell +mkdir -p build-libmetal +cd build-libmetal +cmake -DCMAKE_TOOLCHAIN_FILE= +make VERBOSE=1 DESTDIR= install ``` * Note: When building baremetal for Xilinx 2018.3 or earlier environments, add -DXILINX_PRE_V2019 to your CMake invocation. This will include the @@ -91,17 +91,17 @@ running a Zephyr environment. As Zephyr uses CMake, we build libmetal library and test application as targets of Zephyr CMake project. Here is how to build libmetal for Zephyr: -``` - $ export ZEPHYR_TOOLCHAIN_VARIANT=zephyr - $ export ZEPHYR_SDK_INSTALL_DIR= - $ source /zephyr-env.sh +```shell +export ZEPHYR_TOOLCHAIN_VARIANT=zephyr +export ZEPHYR_SDK_INSTALL_DIR= +source /zephyr-env.sh - $ cmake -DWITH_ZEPHYR=on -DBOARD=qemu_cortex_m3 \ +cmake -DWITH_ZEPHYR=on -DBOARD=qemu_cortex_m3 \ [-DWITH_TESTS=on] - $ make VERBOSE=1 all +make VERBOSE=1 all # If we have turned on tests with "-DWITH_TESTS=on" when we run cmake, # we launch libmetal test on Zephyr QEMU platform as follows: - $ make VERBOSE=1 run +make VERBOSE=1 run ``` ## Interfaces @@ -288,10 +288,10 @@ the following tag instead of the full license text in the individual files: Commit messages must contain Signed-off-by: line and your email must match the change authorship information. Make sure your .gitconfig is set up correctly: - ``` - git config --global user.name "first-name Last-Namer" - git config --global user.email "yourmail@company.com" - ``` +```shell +git config --global user.name "first-name Last-Namer" +git config --global user.email "yourmail@company.com" +``` ### Assisted-by When AI tools are used to contribute to the OpenAMP project, proper attribution helps @@ -319,7 +319,9 @@ command. Run gitlint locally in your tree and branch where your patches have been committed: - ```gitlint``` +```shell +gitlint +``` Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or use the --commits option to specify a commit range @@ -336,10 +338,9 @@ conformity. Checkpatch is available in the scripts directory. To check your \ commits in your git branch: - ``` - ./scripts/checkpatch.pl --strict -g HEAD- - - ``` +```shell +./scripts/checkpatch.pl --strict -g HEAD- +``` ### Send a pull request We use standard GitHub mechanism for pull request. Please refer to GitHub From 6b78981cfaaafbb7b7d98bef3decf7c1b2dbf206 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 31 Aug 2026 10:11:32 +1000 Subject: [PATCH 3/3] README: un-indent code block to avoid showing tag lines With the code block indented the tag lines ``` were shown in readme, so remove the indentation to show only the licence line. Signed-off-by: Sipke Vriend --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fd19a0c32..e4e277656 100644 --- a/README.md +++ b/README.md @@ -280,9 +280,9 @@ compatible with version the is the license covering the OpenAMP distribution as a whole. In practice, use the following tag instead of the full license text in the individual files: - ``` - SPDX-License-Identifier: BSD-3-Clause - ``` +``` +SPDX-License-Identifier: BSD-3-Clause +``` ### Signed-off-by Commit messages must contain Signed-off-by: line and your email must match the