Merge pull request 'added docs for testing release roms' (#18) from shmalebx9/lbwww:maintainers into master
Reviewed-on: https://codeberg.org/libreboot/lbwww/pulls/18hslick-master
commit
0abe43312d
|
@ -0,0 +1,79 @@
|
||||||
|
---
|
||||||
|
title: Board Maintainers Guide
|
||||||
|
x-toc-enable: true
|
||||||
|
...
|
||||||
|
|
||||||
|
Libreboot strives to make Coreboot accessible for as many users as possible.
|
||||||
|
To accomplish this goal, we must add as many boards as possible.
|
||||||
|
As the total number of supported boards increases it becomes more and more difficult
|
||||||
|
for our main contributors to test every single release for every single supported board.
|
||||||
|
We therefore need the help of the community in testing releases before they are
|
||||||
|
distributed to users.
|
||||||
|
|
||||||
|
You do *not* need to be a developer in order to be a board maintainer.
|
||||||
|
All you need to do in order to become a board maintainer is:
|
||||||
|
|
||||||
|
+ Be contactable via email when new testing binaries are available
|
||||||
|
+ Have the correct equipment ready to externally flash your board
|
||||||
|
+ Have the board you wish to maintain
|
||||||
|
|
||||||
|
Once you become a board maintainer, your real name and screen name can
|
||||||
|
be added to the public list on [libreboot.org.](/index.html)
|
||||||
|
You can, of course, choose to forego the public listing.
|
||||||
|
|
||||||
|
To apply as a board maintainer, ping `leah` or `shmalebx9` on
|
||||||
|
[irc,](../../contact.html#irc-chatroom) or email
|
||||||
|
Caleb at [thonkpeasant@protonmail.com](mailto:thonkpeasant@protonmail.com)
|
||||||
|
Do not be afraid to apply to maintain a board with another listed
|
||||||
|
maintainer or multiple maintainers; more is better.
|
||||||
|
|
||||||
|
Please read the following sections to understand the specifics of
|
||||||
|
maintaining a board.
|
||||||
|
|
||||||
|
Be Contactable
|
||||||
|
==============
|
||||||
|
|
||||||
|
You should monitor whatever email you provide in your application.
|
||||||
|
There is no specific time-frame for how long it should take after
|
||||||
|
you receive the email until you report the status of your board.
|
||||||
|
You should make best efforts to respond within a few days.
|
||||||
|
If you are the *only* maintainer for your board then please take
|
||||||
|
into consideration that your input is especially vital.
|
||||||
|
|
||||||
|
Have External Flashing Equipment
|
||||||
|
================================
|
||||||
|
|
||||||
|
The roms you test will of course be untested.
|
||||||
|
To avoid having a bricked machine, you need to have external flashing
|
||||||
|
equipment available for your board to recover from a broken rom.
|
||||||
|
|
||||||
|
In most cases you can refer to the [SPI guide.](../install/spi.html)
|
||||||
|
In rarer cases -such as some ARM chromebooks- your board might be flashed in a different way.
|
||||||
|
Refer to [Coreboot's documentation](https://doc.coreboot.org/)
|
||||||
|
or ask on IRC if you are unsure.
|
||||||
|
|
||||||
|
Testing Procedure
|
||||||
|
=================
|
||||||
|
|
||||||
|
You will receive an email when roms are ready for testing.
|
||||||
|
The email will link to an open issue on our [current git hosting platform.](/git.html#lbmk-libreboot-make)
|
||||||
|
|
||||||
|
Whether you receive an email from a libreboot.org email
|
||||||
|
domain or one of our developer's email you should verify (for
|
||||||
|
your own security)
|
||||||
|
that the downloaded roms are signed with the [official key.](/download.html#gpg-signing-key)
|
||||||
|
|
||||||
|
When your testing is complete, comment on the issue linked in
|
||||||
|
the dispatch email as follows:
|
||||||
|
|
||||||
|
board: `your board`
|
||||||
|
|
||||||
|
status: `pass/fail`
|
||||||
|
|
||||||
|
note: [insert any notes if relevant]
|
||||||
|
|
||||||
|
For example, a board status comment might look like this:
|
||||||
|
|
||||||
|
board: t440p_12mb
|
||||||
|
status: fail
|
||||||
|
note: GRUB throws error 'something_is_b0rked'
|
14
site/faq.md
14
site/faq.md
|
@ -43,6 +43,20 @@ to.
|
||||||
Read the notes about CH341A on [docs/install/spi.md](docs/install/spi.md) to
|
Read the notes about CH341A on [docs/install/spi.md](docs/install/spi.md) to
|
||||||
learn more.
|
learn more.
|
||||||
|
|
||||||
|
How Can I Help
|
||||||
|
--------------
|
||||||
|
|
||||||
|
You do not need to be a skilled developer in order to help the project
|
||||||
|
substantially.
|
||||||
|
If you have a board supported by Coreboot, consider [porting](/docs/maintain/porting.md)
|
||||||
|
it to Libreboot.
|
||||||
|
|
||||||
|
If you have a board supported in Libreboot then please consider becoming a
|
||||||
|
tester.
|
||||||
|
Testing involves minimal effort and really helps out the project.
|
||||||
|
See the [board maintainers documentation](/docs/maintain/testing.md)
|
||||||
|
if you are interested in testing roms before they are released.
|
||||||
|
|
||||||
Flashrom complains about DEVMEM access
|
Flashrom complains about DEVMEM access
|
||||||
--------------------------------------
|
--------------------------------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue