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.

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

docs: cosmetic changes according to megalinter #359

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/src/firmware-action/get_started/01_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Start a new repository in GitHub and the clone it.

## Add coreboot as submodule

~~~admonish tip
```admonish tip
Add git submodule with:
```
~~~
git submodule add <repo> <path>
```
~~~
```

Add [coreboot repository](https://review.coreboot.org/admin/repos/coreboot,general) as a submodule:
```bash
Expand All @@ -32,7 +32,7 @@ Recursively initialize submodules.
git submodule update --init --recursive
```

~~~admonish warning
```admonish warning
Recursively initializing all submodules in coreboot will take a moment.
~~~
```

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Create a coreboot configuration file
# Create a coreboot configuration file

Now we need to create a configuration file for coreboot.

Expand Down
12 changes: 6 additions & 6 deletions docs/src/firmware-action/get_started/03_json_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ This configuration file is for firmware-action, so that it knows what to do and
```
~~~

~~~admonish info
```admonish info
Field `repo_path` is pointing to the location of our coreboot submodule.
~~~
```

~~~admonish info
```admonish info
Field `defconfig_path` is pointing to the location of coreboot's configuration file.
~~~
```

~~~admonish info
```admonish info
Firmware action can be used to compile other firmware too, and even combine multiple firmware projects (to a certain degree).

For this reason the JSON configuration file is divided into categories (`coreboot`, `edk2`, etc). Each category can contain multiple entries.

Entries can depend on each other, which allows you to combine them - you can have for example `coreboot` firmware with `edk2` payload.
~~~
```

Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Then it will proceed to download `coreboot` container (specified by `sdk_url` in

If compilation is successful, a new directory `output-coreboot/` will be created (as specified by `output_dir` in JSON config) which will contain files (specified by `container_output_files` in JSON config) and possibly also directories (specified by `container_output_dirs` in JSON config).

~~~admonish info
```admonish info
`container_output_dirs` and `container_output_files` are lists of directories and files to be extracted from the container once compilation finished successfully.

These are then placed into `output_dir`.
~~~
```

8 changes: 4 additions & 4 deletions docs/src/firmware-action/get_started/06_run_in_ci.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Run firmware-action in GitHub CI
# Run firmware-action in GitHub CI

Now that we have `firmware-action` working on local system. Let's set up CI.

~~~admonish example title=".github/workflows/example.yml"
```yaml
```admonish example title=".github/workflows/example.yml"
~~~yaml
{{#include ../../firmware-action-example/.github/workflows/example.yml}}
```
~~~
```

Commit, push and watch. And that is it.

Expand Down