Date: Sat, 11 Apr 2015 11:48:02 -0400 Subject: docs/maintain/index.html: Add more sections (empty, for now) --- diff --git a/docs/maintain/index.html b/docs/maintain/index.html index fb47bcd..76c1bb9 100644 --- a/docs/maintain/index.html +++ b/docs/maintain/index.html @@ -14,7 +14,9 @@

Maintaining libreboot

This section relates to maintaining libreboot. Work-in-progress

@@ -24,23 +26,91 @@ will be added to frequently from now on.

- Or Back to main index. + This section of the documentation applies mainly to the + development version of libreboot, which is hosted in a git + repository. It is not intended for the release versions of + libreboot.

Updating coreboot-libre
Overview
+ Updating coreboot-libre +
- Adding a new board to libreboot
- Add/remove/modify patches in coreboot-libre
+
+ Updating GRUB +
+
+ Updating flashrom +
- Add/remove/modify patches in flashrom
+
+ Updating bucts +
- Add/remove/modify patches in bucts
+
+ Updating MemTest86+ +
- Add/remove/modify patches in MemTest86+
+

+ +

+ Or Back to main index. +

- +

Overview

+ +

+ The way the libreboot project is run is very similar to how + a GNU/Linux distribution project is run (but for the boot + firmware, not your operating system). +

+ This page demonstrates on a high level how + libreboot is maintained, how the project is run, how everything + goes together, etc. For a more detailed guide, refer to each + subsection for the various components/modules used in libreboot. +

+ TODO: write this section +

+ +

+ Back to top of page. +

+ +

Updating coreboot-libre

- +

Coreboot-libre is the name of the deblobbed coreboot sources used in libreboot. It is also the name of the collection of scripts used for deblobbing coreboot, on each new update.

- +

This section shows an example of how to update (re-base) to the latest version of coreboot, how to update the deblobbing @@ -52,7 +122,7 @@ not listed in this section, you can refer to other sections on this page instead.

- +

Open these files in your editor (you will most likely be editing them):

@@ -65,19 +135,19 @@

resources/scripts/helpers/build/roms/helper

resources/scripts/helpers/build/roms/withgrub

- +

If you already had a coreboot/ directory in your libreboot tree, delete it:
$ rm -rf coreboot/

- +

Firstly, download coreboot. Do not use ./download coreboot for this, just clone coreboot, as it does in that script, like so:
$ git clone http://review.coreboot.org/coreboot

- +

$ cd coreboot/
Get the ID of the latest commit in this clone, by reading the commit ID using @@ -96,19 +166,19 @@ increase the amount of time taken. Now come out of coreboot:
$ cd ../

- +

Check all coreboot file names/paths in deblob; if any of them no longer exist at that name/path in the coreboot tree that you downloaded, delete the reference(s) in deblob.

- +

Check all coreboot file names/paths in nonblobs; if any of them no longer exist at that name/path in the coreboot tree that you downloaded, delete the reference in nonblobs.

- +

Now, back in the main root directory of libreboot (git repository), run the deblob script. This is to prevent the findblobs @@ -116,7 +186,7 @@ when running the deblob script. Like so:
$ ./resources/utilities/coreboot-libre/deblob

- +

Now search for new blobs:
$ cd resources/utilities/coreboot-libre/
@@ -127,7 +197,7 @@ before (because they no longer exist), and it will ignore any files listed in nonblobs.

- +

Once the findblobs script has finished, check the file tocheck (from the root, this will be resources/utilities/coreboot-libre/tocheck). @@ -148,19 +218,19 @@ resources/utilities/coreboot-libre/nonblobs_notes - +

Now come back to the main libreboot root directory (root of the git clone). If you are still in resources/utilities/coreboot-libre/ for instance, you would do something like:
$ cd ../../../

- +

Now delete the coreboot directory:
$ rm -rf coreboot/

- +

Download coreboot again, only this time, using the download script. The download script also applies custom patches @@ -170,7 +240,7 @@ accordingly. Anyway, download coreboot like so:
$ ./download coreboot

- +

+ +

+ TODO: write this section +

+ +

+ Back to top of page. +

@@ -209,7 +447,7 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See ../license.txt for more information.

- +

-- cgit v0.9.1