Skip to content

Commit

Permalink
README.md: spelling and formatting corrections, removal of depecated …
Browse files Browse the repository at this point in the history
…pce-fw-builder support

Signed-off-by: Piotr Król <[email protected]>
  • Loading branch information
pietrushnic committed Dec 27, 2024
1 parent cd7eec8 commit 5dcfdc4
Showing 1 changed file with 10 additions and 19 deletions.
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ information on contributing to the Dasharo project.

## Usage

Following procedure was created while testing PC Engines v24.05.00.01. It
should be generalized after gaining better understanding of the Dasharo
Patchqueue Initiative.
Following procedure was created while testing PC Engines v24.05.00.01 and
retested while releasing v24.08.00.01. It should be generalized after gaining
better understanding of the Dasharo Patchqueue Initiative.

### Prepare code base

Expand Down Expand Up @@ -44,7 +44,8 @@ Go to `.git/patches` and checkout correct patchqueue version:
cd .git/patches
```

In this case we plan to build Dasahro (coreboot+SeaBIOS) v24.05.00.01 for PC Engines:
In this case we plan to build Dasharo (coreboot+SeaBIOS) v25.08.00.01 for PC
Engines:

```bash
git checkout v25.08.00.01
Expand Down Expand Up @@ -121,13 +122,13 @@ git tag -a v24.08.00.01 -m "Some annotation which conten really doesn't matter"

## Development

### How to handle bug in patches ?
### How to handle bug in patches?

- pop patches using `guilt pop` until you will have broken one on top of stack,
- modify files,
- Pop patches using `guilt pop` until you will have broken one on top of stack,
- Modify files,
- `guilt refresh` - this will store changes in required patch
- `guilt push -a` - to make sure all patches on top apply without problems
- commit changes to this repository
- Commit changes to this repository

Read `man guilt-pop` for efficient popping.

Expand Down Expand Up @@ -155,16 +156,6 @@ application issues. After resolving issues for given patch use `git add` to
stage required changes and `guilt refresh` to update patch, so it reflects
cleanly applicable change.

At this point you may need to check if code still compiles at this point, that
why [pce-fw-builder update](#pce-fw-builder-update) may be useful.

#### pce-fw-builder update

To understood what changes may be needed to
[pce-fw-builder](https://github.com/pcengines/pce-fw-builder) when updating to
new coreboot version, please check [this
MR](https://github.com/pcengines/pce-fw-builder/pull/66).

## Background

The `dasharo-pq` repository was created as a proof of concept to address issues
Expand Down Expand Up @@ -215,7 +206,7 @@ mentioned in [#310](https://github.com/Dasharo/dasharo-issues/issues/310).

### Why Track Patches in Git Instead of Just Using Branches?

> Follwing list of arguments was heavily influenced by discussion in
> Following list of arguments was heavily influenced by discussion in
> [#5](https://github.com/Dasharo/dasharo-pq/pull/5). Kudos to:
> [@krystian-hebel](https://github.com/krystian-hebel),
> [@andyhhp](https://github.com/andyhhp),
Expand Down

0 comments on commit 5dcfdc4

Please sign in to comment.