aboutsummaryrefslogtreecommitdiff
path: root/docs/git
diff options
context:
space:
mode:
authorAlyssa Rosenzweig <alyssa@rosenzweig.io>2017-03-17 22:55:29 -0700
committerAlyssa Rosenzweig <alyssa@rosenzweig.io>2017-03-17 22:55:29 -0700
commitb967baa8118b34fb3fd36d4c3b8b1c21495f9aa4 (patch)
treef461ce307a781ba49ea3751482736e68d7c76f04 /docs/git
parent60926e9fc770fc1f310306447220cb3740382b00 (diff)
downloadlibrebootfr-b967baa8118b34fb3fd36d4c3b8b1c21495f9aa4.tar.gz
librebootfr-b967baa8118b34fb3fd36d4c3b8b1c21495f9aa4.zip
Cleanup some escaped symbols
Diffstat (limited to 'docs/git')
-rw-r--r--docs/git/index.md74
1 files changed, 37 insertions, 37 deletions
diff --git a/docs/git/index.md b/docs/git/index.md
index 30ba50e2..21f9a4ce 100644
--- a/docs/git/index.md
+++ b/docs/git/index.md
@@ -33,11 +33,11 @@ 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**\
+$ **sudo ./oldbuild dependencies debian**\
(this will also work in Devuan)
For Parabola, you can run the following command:\
-\$ **sudo ./oldbuild dependencies parabola**\
+$ **sudo ./oldbuild dependencies parabola**\
or:\
\# **./oldbuild dependencies parabola**
@@ -64,21 +64,21 @@ 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**\
+$ **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**
+$ **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**
+$ **./download all**
What this did was download everything (grub, coreboot, memtest86+,
bucts, flashrom) at the versions last tested for this release, and patch
@@ -102,7 +102,7 @@ a register in the chipset on some Intel systems.
Bucts is needed when flashing in software the X60/X60S/X60T/T60 ROM
while Lenovo BIOS is running; external flashing will be safe regardless.
Each ROM contains identical data inside the two final 64K region in the
-file\*. This corresponds to the final two 64K regions in the flash chip.
+file*. This corresponds to the final two 64K regions in the flash chip.
Lenovo BIOS will prevent you from writing the final one, so running
"**bucts 1**" will set the system to boot from the other block instead
(which is writeable along with everything beneath it when using a
@@ -112,7 +112,7 @@ final 64K block is writeable so you flash the ROM again with an
unpatched flashrom and run "**bucts 0**" to make the system boot from
the normal (highest) block again.
-\*Libreboot ROM images have identical data in those two 64KiB regions
+*Libreboot ROM images have identical data in those two 64KiB regions
because dd is used to do that, by the build system. If you're building
from upstream (coreboot), you have to do it manually.
@@ -137,10 +137,10 @@ 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**
+$ **./oldbuild module bucts**
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.
@@ -168,10 +168,10 @@ 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**
+$ **./oldbuild module flashrom**
To statically compile it, do the following in the main directory:\
-\$ **./oldbuild module flashrom static**
+$ **./oldbuild module flashrom static**
After you've done that, under ./flashrom/ you will find the following
executables:
@@ -215,24 +215,24 @@ If you downloaded libreboot from git, refer to
[\#build\_meta](#build_meta).
Build all of the components used in libreboot:\
-\$ **./oldbuild module all**
+$ **./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**
+$ **./oldbuild module list**
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**\
+$ **./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**
+$ **./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
@@ -243,47 +243,47 @@ Preparing release archives (optional)
-------------------------------------
**This is only confirmed to work (tested) in Debian Stretch. Parabola
-\*fails\* at this stage (for now). For all other distros, YMMV. This
+*fails* at this stage (for now). For all other distros, YMMV. This
will also work in Devuan.**
This is mainly intended for use with the git repository. These commands
will work in the release archive (\_src), unless otherwise noted below.
-The archives will appear under *release/oldbuildsystem/\${version}/*;
-\${version} will either be set using *git describe* or, if a *version*
+The archives will appear under *release/oldbuildsystem/${version}/*;
+${version} will either be set using *git describe* or, if a *version*
file already exists (\_src release archive), then it will simply re-use
that.
Tag the current commit, and that version will appear in both the
-\${version} string on the directory under *release/oldbuildsystem/*, and
+${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.
Utilities (static executables):\
-\$ **./oldbuild release util**
+$ **./oldbuild release util**
Archive containing flashrom and bucts source code:\
-\$ **./oldbuild release tobuild**
+$ **./oldbuild release tobuild**
Documentation archive (**does not work on \_src release archive, only
git**):\
-\$ **./oldbuild release docs**
+$ **./oldbuild release docs**
ROM image archives:\
-\$ **./oldbuild release roms**
+$ **./oldbuild release roms**
Source code archive:\
-\$ **./oldbuild release src**
+$ **./oldbuild release src**
SHA512 sums of all other release archives that have been generated:\
-\$ **./oldbuild release sha512sums**
+$ **./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:
**nvramtool, cbfstool, ich9deblob, cbmem**.
If you are building on an x86\_64 host, this will build statically
-linked 32- \*and\* 64-bit binaries for **cbmem**, **ich9deblob**,
+linked 32- *and* 64-bit binaries for **cbmem**, **ich9deblob**,
**cbfstool** and **nvramtool**.
**To include statically linked i686 and x86\_64 binaries for bucts and
@@ -305,8 +305,8 @@ libreboot\_util, for:
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**
+$ **./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
@@ -316,7 +316,7 @@ restrictions).
The command that you used for generating the release archives will also
run the following command:\
-\$ **./oldbuild release tobuild**\
+$ **./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.