libreboot / lbwww (public) (License: Unspecified) (since 2023-04-11) (hash sha1)
libreboot website (markdown files). https://libreboot.org/
Clone URLs: https://rocketgit.com/user/libreboot/lbwww ssh://rocketgit@ssh.rocketgit.com/user/libreboot/lbwww git://git.rocketgit.com/user/libreboot/lbwww
25.04 25.06 master
List of commits:
Subject Hash Author Date (UTC)
docs/build: specify system requirements e6e952ac11b64f0dddf1beff68f36f07b48396ea Leah Rowe 2025-01-04 17:07:27
tidy up the vendor inject guide 08f35ff1b6d5d8a8481a3fecf7c2b44f9a978982 Leah Rowe 2025-01-04 15:42:38
install/nvmutil: Safer cat/de-cat instructions c587cee2ac9f3e36f36b978da63279e7241ecb2a Leah Rowe 2025-01-04 15:34:11
ivy_has_common: Mention deguard there 2361a1de72810be49921fadd8f27696f0d88aaab Leah Rowe 2025-01-04 15:12:34
ivy_has_common: shorten the FSP section b11a61c97c5618fc2aa03d3c2e57a8f91b0f8e31 Leah Rowe 2025-01-04 15:09:11
docs/build: tidy up debian trixie notes 1e117c77af7f60e50d9c56e7b9053e0e4eb01bb4 Leah Rowe 2025-01-04 03:08:17
further clarification b6929f8381e99e5d6d647092d1c45ed687eb1bf1 Leah Rowe 2025-01-04 00:28:30
further debian trixie/sid instructions c3037165691d6d34bcce4b709336fd1d7726346c Leah Rowe 2025-01-04 00:25:09
docs/build: mention gcc/gnat version match issue ed08e80f5972ed9e258d275024b356281958106e Leah Rowe 2025-01-04 00:20:43
make the text SLIGHTLY smaller 8c2e77e0c742c3d1b7f3f9d78ca15ecf91d2ca75 Leah Rowe 2025-01-03 10:20:23
remove a pointless link ec57019f3eda5e12849287c1e34f6ed1046bbb7c Leah Rowe 2025-01-03 08:37:35
update links to the inject guide 6ae9714ecfba82c8a2ccae648f29350b5fe40606 Leah Rowe 2025-01-03 07:30:12
further cleanup 12b4f64b1b6a5495dc74870de3cbda8f8d78d1fc Leah Rowe 2025-01-03 06:58:04
update the vendorfile injection guide 9d018b474a661b8ca3f69843ce4d2c7702435462 Leah Rowe 2025-01-03 05:24:44
update the freedom-status page c3ad859ea09a00ad6d2709d109daf1d63ab2bdf3 Leah Rowe 2025-01-03 01:07:20
docs/build: Update fedora38 reference to fedora41 6c57ce1586aebdbc79255f1cc023e3eca1e494b4 Leah Rowe 2025-01-01 17:09:20
XBMK_THREADS, not LBMK_THREADS 4d7f0dbb9dd5ad1c84adc9d40fbb36f44ec5a557 Leah Rowe 2025-01-01 16:53:19
docs/build: Mention MIPS XGCC for PCSX-Redux BIOS a1ff143fe641f7e79a19372ca5ed0dbf3c3c06f3 Leah Rowe 2025-01-01 16:52:00
correction 2c7d4c4df855f85f18ef5998b54ce423d543bfa4 Leah Rowe 2024-12-31 23:58:10
another typo 965baf9bb0b16f10bd9cefc2bcd4115ca7408246 Leah Rowe 2024-12-31 21:46:55
Commit e6e952ac11b64f0dddf1beff68f36f07b48396ea - docs/build: specify system requirements
Signed-off-by: Leah Rowe <leah@libreboot.org>
Author: Leah Rowe
Author date (UTC): 2025-01-04 17:07
Committer name: Leah Rowe
Committer date (UTC): 2025-01-04 17:07
Parent(s): 08f35ff1b6d5d8a8481a3fecf7c2b44f9a978982
Signer:
Signing key:
Signing status: N
Tree: d07e268bc18352d65416c774d4d399e75d0ef6bf
File Lines added Lines deleted
site/docs/build/index.md 75 21
site/docs/build/index.uk.md 57 0
File site/docs/build/index.md changed (mode: 100644) (index 9508b8e..db16e1c)
... ... do nicely.
15 15 Introduction Introduction
16 16 ============ ============
17 17
18 libreboot's build system is named `lbmk`, short for `LibreBoot MaKe`, and this
18 Libreboot's build system is named `lbmk`, short for `LibreBoot MaKe`, and this
19 19 document describes how to use it. With this guide, you can know how to compile document describes how to use it. With this guide, you can know how to compile
20 20 libreboot from the available source code. libreboot from the available source code.
21 21
22 22 The following document describes how `lbmk` works, and how you can make changes The following document describes how `lbmk` works, and how you can make changes
23 23 to it: [libreboot maintenance manual](../maintain/) to it: [libreboot maintenance manual](../maintain/)
24 24
25 System requirements
26 ===================
27
28 This concerns system requirements when *building* Libreboot.
29
30 Operating system
31 ----------------
32
33 Any sensible Linux distribution will do. Libreboot's build system is regularly
34 testing on all the major distros. Please do report bugs if you encounter
35 issues.
36
37 Host CPU
38 --------
39
40 At least an Intel Core 2 Duo, though we recommend much faster CPUs if building
41 entire release archives, e.g. quad-core Haswell CPU or better.
42
43 NOTE: x86 boards require an *x86_64* host CPU with appropriate host toolchains
44 and libraries. We don't yet cross-compile x86 payloads.
45
46 NOTE2: ARM64 mainboards *are* cross compiled, so you can build for AArch64
47 machines quite easily, from x86 or ARM64 machines.
48
49 NOTE3: *32-bit* x86 (i686) machines can be used to compile Libreboot, but
50 MemTest86\+ is only compiled for 64-bit, and not cross compiled, so builds
51 are disabled when lbmk detects a 32-bit host CPU.
52
53 Memory
54 ------
55
56 At least 2GB per CPU core, ideally 4GB; for example, 16GB RAM is recommended
57 if you're compiling an a quad-core CPU.
58
59 NOTE: `XBMK_THREADS` environmental variable defaults to 1 if unset. This sets
60 the number of build threads, which you should match to the number of cores.
61 For example, when you're building on a quad-core, do this prior to building:
62
63 export XBMK_THREADS=4
64
65 Disk space
66 ----------
67
68 About 20GB bare minimum, if only compiling for 1 board. The sources take up a
69 lot of space. However, Libreboot is always expanding as it's developed.
70
71 At least 50GB of free disk space is therefor recommended.
72
73 We *actually* recommend 100GB, because Libreboot will also have a Linux distro
74 in flash on a future release. On our testing, disk I/O does not seem to be a
75 major bottleneck, so any HDD or SSD will do, but we obviously recommend a
76 fast NVMe (PCI-E) SSD if you can.
77
25 78 Multi-threaded builds Multi-threaded builds
26 79 ===================== =====================
27 80
 
... ... This version, if hosted live on libreboot.org, assumes that you are using
51 104 the `lbmk` git repository, which the `lbmk` git repository, which
52 105 you can download using the instructions on [the code review page](../../git.md). you can download using the instructions on [the code review page](../../git.md).
53 106
54 A note about documentation (and this page)
55 ------------------------------------------
56
57 From Libreboot 20231021 onwards, *all* releases (including 20231021)
58 have `lbwww.git` (the website) and `lbwww-img.git` (images for the website)
59 archived in the *src* tar archive for that release; older releases were hit
60 or miss, from 20210522 to 20230625, as to whether they came with documentation;
61 releases older than 20210522 generally always came with documentation. Modern
62 Libreboot documentation is written in Markdown (pandoc variant)
63
64 If you're working with *release* documentation, you don't get the full HTML
65 files (such as the one you're viewing now, if you're reading *this* page in a
66 web browser), so either read the Markdown files directly, or compile them to
67 HTML using the [Untitled Static Site Generator](https://untitled.vimuser.org/)
68 (which is what the Libreboot project uses to generate HTML from those files).
69
70 NOTE: `av.libreboot.org` is hardcoded as the domain name where images are
71 pointed to, in `lbwww.git`, so you will need to replace these references in
72 your local version, unless you're happy to just continue using those.
73
74 107 Git Git
75 108 === ===
76 109
 
... ... example want to modify a config, e.g.:
261 294
262 295 Or perhaps add a new board! The maintenance manual will teach you how the Or perhaps add a new board! The maintenance manual will teach you how the
263 296 Libreboot build system (lbmk) works! Libreboot build system (lbmk) works!
297
298 A note about documentation (and this page)
299 ==========================================
300
301 From Libreboot 20231021 onwards, *all* releases (including 20231021)
302 have `lbwww.git` (the website) and `lbwww-img.git` (images for the website)
303 archived in the *src* tar archive for that release; older releases were hit
304 or miss, from 20210522 to 20230625, as to whether they came with documentation;
305 releases older than 20210522 generally always came with documentation. Modern
306 Libreboot documentation is written in Markdown (pandoc variant)
307
308 If you're working with *release* documentation, you don't get the full HTML
309 files (such as the one you're viewing now, if you're reading *this* page in a
310 web browser), so either read the Markdown files directly, or compile them to
311 HTML using the [Untitled Static Site Generator](https://untitled.vimuser.org/)
312 (which is what the Libreboot project uses to generate HTML from those files).
313
314 NOTE: `av.libreboot.org` is hardcoded as the domain name where images are
315 pointed to, in `lbwww.git`, so you will need to replace these references in
316 your local version, unless you're happy to just continue using those.
317
File site/docs/build/index.uk.md changed (mode: 100644) (index 8e8f3e7..04223bb)
... ... title: Побудова з джерельного коду
3 3 x-toc-enable: true x-toc-enable: true
4 4 ... ...
5 5
6 **TODO: This page needs to be re-translated. Much of the newer sections are
7 still in English, and there may be some differences aside from translation,
8 versus the English version.**
9
6 10 WARNING: eCryptfs file name limits WARNING: eCryptfs file name limits
7 11 ================================= =================================
8 12
 
... ... libreboot з доступного джерельного коду.
30 34 Наступний документ описує те, як працює `lbmk`, і як ви можете робити зміни Наступний документ описує те, як працює `lbmk`, і як ви можете робити зміни
31 35 до нього: [керівництво обслуговування libreboot](../maintain/) до нього: [керівництво обслуговування libreboot](../maintain/)
32 36
37 System requirements
38 ===================
39
40 This concerns system requirements when *building* Libreboot.
41
42 Operating system
43 ----------------
44
45 Any sensible Linux distribution will do. Libreboot's build system is regularly
46 testing on all the major distros. Please do report bugs if you encounter
47 issues.
48
49 Host CPU
50 --------
51
52 At least an Intel Core 2 Duo, though we recommend much faster CPUs if building
53 entire release archives, e.g. quad-core Haswell CPU or better.
54
55 NOTE: x86 boards require an *x86_64* host CPU with appropriate host toolchains
56 and libraries. We don't yet cross-compile x86 payloads.
57
58 NOTE2: ARM64 mainboards *are* cross compiled, so you can build for AArch64
59 machines quite easily, from x86 or ARM64 machines.
60
61 NOTE3: *32-bit* x86 (i686) machines can be used to compile Libreboot, but
62 MemTest86\+ is only compiled for 64-bit, and not cross compiled, so builds
63 are disabled when lbmk detects a 32-bit host CPU.
64
65 Memory
66 ------
67
68 At least 2GB per CPU core, ideally 4GB; for example, 16GB RAM is recommended
69 if you're compiling an a quad-core CPU.
70
71 NOTE: `XBMK_THREADS` environmental variable defaults to 1 if unset. This sets
72 the number of build threads, which you should match to the number of cores.
73 For example, when you're building on a quad-core, do this prior to building:
74
75 export XBMK_THREADS=4
76
77 Disk space
78 ----------
79
80 About 20GB bare minimum, if only compiling for 1 board. The sources take up a
81 lot of space. However, Libreboot is always expanding as it's developed.
82
83 At least 50GB of free disk space is therefor recommended.
84
85 We *actually* recommend 100GB, because Libreboot will also have a Linux distro
86 in flash on a future release. On our testing, disk I/O does not seem to be a
87 major bottleneck, so any HDD or SSD will do, but we obviously recommend a
88 fast NVMe (PCI-E) SSD if you can.
89
33 90 Multi-threaded builds Multi-threaded builds
34 91 ===================== =====================
35 92
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/libreboot/lbwww

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/libreboot/lbwww

Clone this repository using git:
git clone git://git.rocketgit.com/user/libreboot/lbwww

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main