aboutsummaryrefslogtreecommitdiff
path: root/docs/git
diff options
context:
space:
mode:
authorLeah Rowe <info@minifree.org>2017-04-03 20:57:12 +0200
committerGogs <gogitservice@gmail.com>2017-04-03 20:57:12 +0200
commite5d71ae5577d2ebafbda4a43a20211e996365d3f (patch)
tree031c0024b35c735a9461b1456fda5d125e7fe901 /docs/git
parentf02ec452b4628e87121412e14ad9899cd85f98d5 (diff)
parent26c4759b17383087f7eba9f765dc63327d905a02 (diff)
downloadlibrebootfr-e5d71ae5577d2ebafbda4a43a20211e996365d3f.tar.gz
librebootfr-e5d71ae5577d2ebafbda4a43a20211e996365d3f.zip
Merge branch 'web/code-blocks' of vimuser/libreboot into master
Diffstat (limited to 'docs/git')
-rw-r--r--docs/git/index.md131
1 files changed, 76 insertions, 55 deletions
diff --git a/docs/git/index.md b/docs/git/index.md
index 30ba50e2..65755138 100644
--- a/docs/git/index.md
+++ b/docs/git/index.md
@@ -16,6 +16,7 @@ the git repository.
- [Get the full source code from metadata (git clone)](#build_meta)
- [How to build "bucts" (for LenovoBIOS
X60/X60S/X60T/T60)](#build_bucts)
+
- [How to build "flashrom"](#build_flashrom)
- [How to build the ROM images](#build)
@@ -32,14 +33,14 @@ statically compiled executables for the utilities are included.**
For Debian Stretch (may also work on Debian Jessie), you can run the
-following command:\
-\$ **sudo ./oldbuild dependencies debian**\
+following command:
+ $ sudo ./oldbuild dependencies debian
(this will also work in Devuan)
-For Parabola, you can run the following command:\
-\$ **sudo ./oldbuild dependencies parabola**\
-or:\
-\# **./oldbuild dependencies parabola**
+For Parabola, you can run the following command:
+ $ sudo ./oldbuild dependencies parabola\
+or:
+ # ./oldbuild dependencies parabola
For other GNU+Linux distributions, you can adapt the existing scripts.
@@ -63,22 +64,25 @@ First, [install the build dependencies](#build_dependencies).
Since libreboot makes extensive use of git, you need to configure git
properly. If you have not yet configured git, then the minimum
-requirement is:\
-\$ **git config \--global user.name "Your Name"**\
-\$ **git config \--global user.email your@emailaddress.com**\
+requirement is:
+
+ $ git config --global user.name "Your Name"
+ $ git config --global user.email your@emailaddress.com
This is what will also appear in git logs if you ever commit your own
changes to a given repository. For more information, see
<http://git-scm.com/doc>.
-Another nice config for you (optional, but recommended):\
-\$ **git config \--global core.editor nano**\
-\$ **git config \--global color.status auto**\
-\$ **git config \--global color.branch auto**\
-\$ **git config \--global color.interactive auto**\
-\$ **git config \--global color.diff auto**
+Another nice config for you (optional, but recommended):
+
+ $ git config --global core.editor nano
+ $ git config --global color.status auto
+ $ git config --global color.branch auto
+ $ git config --global color.interactive auto
+ $ git config --global color.diff auto
-After that, run the script:\
-\$ **./download all**
+After that, run the script:
+
+ $ ./download all
What this did was download everything (grub, coreboot, memtest86+,
bucts, flashrom) at the versions last tested for this release, and patch
@@ -136,11 +140,13 @@ If you have the binary release archive, you'll find executables under
First, [install the build dependencies](#build_dependencies).
-To build bucts, do this in the main directory:\
-\$ **./oldbuild module bucts**
+To build bucts, do this in the main directory:
+
+ $ ./oldbuild module bucts
+
+To statically compile it, do this:
-To statically compile it, do this:\
-\$ **./oldbuild module bucts static**
+ $ ./oldbuild module bucts static
The "builddeps" script in libreboot\_src also makes use of
builddeps-bucts.
@@ -167,11 +173,13 @@ flashrom from source, continue reading.
First, [install the build dependencies](#build_dependencies).
-To build it, do the following in the main directory:\
-\$ **./oldbuild module flashrom**
+To build it, do the following in the main directory:
-To statically compile it, do the following in the main directory:\
-\$ **./oldbuild module flashrom static**
+ $ ./oldbuild module flashrom
+
+To statically compile it, do the following in the main directory:
+
+ $ ./oldbuild module flashrom static
After you've done that, under ./flashrom/ you will find the following
executables:
@@ -214,25 +222,30 @@ First, [install the build dependencies](#build_dependencies).
If you downloaded libreboot from git, refer to
[\#build\_meta](#build_meta).
-Build all of the components used in libreboot:\
-\$ **./oldbuild module all**
+Build all of the components used in libreboot:
+
+ $ ./oldbuild module all
You can also build each modules separately, using *./oldbuild module
-modulename*. To see the possible values for *modulename*, use:\
-\$ **./oldbuild module list**
+modulename*. To see the possible values for *modulename*, use:
+
+ $ ./oldbuild module list
+
+After that, build the ROM images (for all boards):
-After that, build the ROM images (for all boards):\
-\$ **./oldbuild roms withgrub**\
+ $ ./oldbuild roms withgrub
Alternatively, you can build for a specific board or set of boards. For
-example:\
-\$ **./oldbuild roms withgrub x60**\
-\$ **./oldbuild roms withgrub x200\_8mb**\
-\$ **./oldbuild roms withgrub x60 x200\_8mb**\
+example:
+
+ $ ./oldbuild roms withgrub x60
+ $ ./oldbuild roms withgrub x200\_8mb
+ $ ./oldbuild roms withgrub x60 x200\_8mb
The list of board options can be found by looking at the directory names
in **resources/libreboot/config/grub/**.
-To clean (reverse) everything, do the following:\
-\$ **./oldbuild clean all**
+To clean (reverse) everything, do the following:
+
+ $ ./oldbuild clean all
The ROM images will be stored under **bin/*payload*/**, where *payload*
could be *grub*, *seabios*, or whatever other payload those images were
@@ -257,26 +270,32 @@ that.
Tag the current commit, and that version will appear in both the
\${version} string on the directory under *release/oldbuildsystem/*, and
in the file names of the archives. Otherwise, whatever git uses for *git
-describe \--tags HEAD* will be used.
+describe --tags HEAD* will be used.
+
+Utilities (static executables):
-Utilities (static executables):\
-\$ **./oldbuild release util**
+ $ ./oldbuild release util
-Archive containing flashrom and bucts source code:\
-\$ **./oldbuild release tobuild**
+Archive containing flashrom and bucts source code:
+
+ $ ./oldbuild release tobuild
Documentation archive (**does not work on \_src release archive, only
-git**):\
-\$ **./oldbuild release docs**
+git**):
+
+ $ ./oldbuild release docs
-ROM image archives:\
-\$ **./oldbuild release roms**
+ROM image archives:
-Source code archive:\
-\$ **./oldbuild release src**
+ $ ./oldbuild release roms
-SHA512 sums of all other release archives that have been generated:\
-\$ **./oldbuild release sha512sums**
+Source code archive:
+
+ $ ./oldbuild release src
+
+SHA512 sums of all other release archives that have been generated:
+
+ $ ./oldbuild release sha512sums
If you are building on an i686 host, this will build statically linked
32-bit binaries in the binary release archive that you created, for:
@@ -304,9 +323,10 @@ libreboot\_util, for:
- flashrom
If you are building binaries on a live system or chroot (for
-flashrom/bucts), you can use the following to statically link them:\
-\$ **./oldbuild module flashrom static**\
-\$ **./oldbuild module bucts static**
+flashrom/bucts), you can use the following to statically link them:
+
+ $ ./oldbuild module flashrom static
+ $ ./oldbuild module bucts static
The same conditions as above apply for ARM (except, building bucts on
ARM is pointless, and for flashrom you only need the normal executable
@@ -315,8 +335,9 @@ an X60/T60 while lenovo bios is present, working around the security
restrictions).
The command that you used for generating the release archives will also
-run the following command:\
-\$ **./oldbuild release tobuild**\
+run the following command:
+
+ $ ./oldbuild release tobuild
The archive **tobuild.tar.xz** will have been created under
**release/oldbuildsystem/**, containing bucts, flashrom and all other
required resources for building them.