docs/build: specify system requirements
Signed-off-by: Leah Rowe <leah@libreboot.org>master
parent
5ec5f82e51
commit
4e5be610cd
|
@ -22,6 +22,59 @@ canoeboot from the available source code.
|
||||||
The following document describes how `cbmk` works, and how you can make changes
|
The following document describes how `cbmk` works, and how you can make changes
|
||||||
to it: [canoeboot maintenance manual](../maintain/)
|
to it: [canoeboot maintenance manual](../maintain/)
|
||||||
|
|
||||||
|
System requirements
|
||||||
|
===================
|
||||||
|
|
||||||
|
This concerns system requirements when *building* Canoeboot.
|
||||||
|
|
||||||
|
Operating system
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Any sensible Linux distribution will do. Canoeboot's build system is regularly
|
||||||
|
testing on all the major distros. Please do report bugs if you encounter
|
||||||
|
issues.
|
||||||
|
|
||||||
|
Host CPU
|
||||||
|
--------
|
||||||
|
|
||||||
|
At least an Intel Core 2 Duo, though we recommend much faster CPUs if building
|
||||||
|
entire release archives, e.g. quad-core Haswell CPU or better.
|
||||||
|
|
||||||
|
NOTE: x86 boards require an *x86_64* host CPU with appropriate host toolchains
|
||||||
|
and libraries. We don't yet cross-compile x86 payloads.
|
||||||
|
|
||||||
|
NOTE2: ARM64 mainboards *are* cross compiled, so you can build for AArch64
|
||||||
|
machines quite easily, from x86 or ARM64 machines.
|
||||||
|
|
||||||
|
NOTE3: *32-bit* x86 (i686) machines can be used to compile Canoeboot, but
|
||||||
|
MemTest86\+ is only compiled for 64-bit, and not cross compiled, so builds
|
||||||
|
are disabled when cbmk detects a 32-bit host CPU.
|
||||||
|
|
||||||
|
Memory
|
||||||
|
------
|
||||||
|
|
||||||
|
At least 2GB per CPU core, ideally 4GB; for example, 16GB RAM is recommended
|
||||||
|
if you're compiling an a quad-core CPU.
|
||||||
|
|
||||||
|
NOTE: `XBMK_THREADS` environmental variable defaults to 1 if unset. This sets
|
||||||
|
the number of build threads, which you should match to the number of cores.
|
||||||
|
For example, when you're building on a quad-core, do this prior to building:
|
||||||
|
|
||||||
|
export XBMK_THREADS=4
|
||||||
|
|
||||||
|
Disk space
|
||||||
|
----------
|
||||||
|
|
||||||
|
About 20GB bare minimum, if only compiling for 1 board. The sources take up a
|
||||||
|
lot of space. However, Canoeboot is always expanding as it's developed.
|
||||||
|
|
||||||
|
At least 50GB of free disk space is therefor recommended.
|
||||||
|
|
||||||
|
We *actually* recommend 100GB, because Canoeboot will also have a Linux distro
|
||||||
|
in flash on a future release. On our testing, disk I/O does not seem to be a
|
||||||
|
major bottleneck, so any HDD or SSD will do, but we obviously recommend a
|
||||||
|
fast NVMe (PCI-E) SSD if you can.
|
||||||
|
|
||||||
Multi-threaded builds
|
Multi-threaded builds
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
@ -51,25 +104,6 @@ This version, if hosted live on canoeboot.org, assumes that you are using
|
||||||
the `cbmk` git repository, which
|
the `cbmk` git repository, which
|
||||||
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).
|
||||||
|
|
||||||
A note about documentation (and this page)
|
|
||||||
------------------------------------------
|
|
||||||
|
|
||||||
Including Canoeboot 20231026 and newer, *all* releases have `cbwww.git` (the
|
|
||||||
website) and `cbwww-img.git` (images for the website) archived in the *src* tar
|
|
||||||
archive for that release; Canoeboot documentation is written in Markdown (pandoc
|
|
||||||
variant). You can find markdown files and images under `src/www/`
|
|
||||||
and `src/img/`, respectively.
|
|
||||||
|
|
||||||
If you're working with *release* documentation, you don't get the full HTML
|
|
||||||
files (such as the one you're viewing now, if you're reading *this* page in a
|
|
||||||
web browser), so either read the Markdown files directly, or compile them to
|
|
||||||
HTML using the [Untitled Static Site Generator](https://untitled.vimuser.org/)
|
|
||||||
(which is what the Canoeboot project uses to generate HTML from those files).
|
|
||||||
|
|
||||||
NOTE: `av.canoeboot.org` is hardcoded as the domain name where images are
|
|
||||||
pointed to, in `cbwww.git`, so you will need to replace these references in
|
|
||||||
your local version, unless you're happy to just continue using those.
|
|
||||||
|
|
||||||
Git
|
Git
|
||||||
===
|
===
|
||||||
|
|
||||||
|
|
|
@ -3,6 +3,10 @@ title: Побудова з джерельного коду
|
||||||
x-toc-enable: true
|
x-toc-enable: true
|
||||||
...
|
...
|
||||||
|
|
||||||
|
**TODO: This page needs to be re-translated. Much of the newer sections are
|
||||||
|
still in English, and there may be some differences aside from translation,
|
||||||
|
versus the English version.**
|
||||||
|
|
||||||
WARNING: eCryptfs file name limits
|
WARNING: eCryptfs file name limits
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
|
@ -30,6 +34,59 @@ canoeboot з доступного джерельного коду.
|
||||||
Наступний документ описує те, як працює `cbmk`, і як ви можете робити зміни
|
Наступний документ описує те, як працює `cbmk`, і як ви можете робити зміни
|
||||||
до нього: [керівництво обслуговування canoeboot](../maintain/)
|
до нього: [керівництво обслуговування canoeboot](../maintain/)
|
||||||
|
|
||||||
|
System requirements
|
||||||
|
===================
|
||||||
|
|
||||||
|
This concerns system requirements when *building* Canoeboot.
|
||||||
|
|
||||||
|
Operating system
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Any sensible Linux distribution will do. Canoeboot's build system is regularly
|
||||||
|
testing on all the major distros. Please do report bugs if you encounter
|
||||||
|
issues.
|
||||||
|
|
||||||
|
Host CPU
|
||||||
|
--------
|
||||||
|
|
||||||
|
At least an Intel Core 2 Duo, though we recommend much faster CPUs if building
|
||||||
|
entire release archives, e.g. quad-core Haswell CPU or better.
|
||||||
|
|
||||||
|
NOTE: x86 boards require an *x86_64* host CPU with appropriate host toolchains
|
||||||
|
and libraries. We don't yet cross-compile x86 payloads.
|
||||||
|
|
||||||
|
NOTE2: ARM64 mainboards *are* cross compiled, so you can build for AArch64
|
||||||
|
machines quite easily, from x86 or ARM64 machines.
|
||||||
|
|
||||||
|
NOTE3: *32-bit* x86 (i686) machines can be used to compile Canoeboot, but
|
||||||
|
MemTest86\+ is only compiled for 64-bit, and not cross compiled, so builds
|
||||||
|
are disabled when cbmk detects a 32-bit host CPU.
|
||||||
|
|
||||||
|
Memory
|
||||||
|
------
|
||||||
|
|
||||||
|
At least 2GB per CPU core, ideally 4GB; for example, 16GB RAM is recommended
|
||||||
|
if you're compiling an a quad-core CPU.
|
||||||
|
|
||||||
|
NOTE: `XBMK_THREADS` environmental variable defaults to 1 if unset. This sets
|
||||||
|
the number of build threads, which you should match to the number of cores.
|
||||||
|
For example, when you're building on a quad-core, do this prior to building:
|
||||||
|
|
||||||
|
export XBMK_THREADS=4
|
||||||
|
|
||||||
|
Disk space
|
||||||
|
----------
|
||||||
|
|
||||||
|
About 20GB bare minimum, if only compiling for 1 board. The sources take up a
|
||||||
|
lot of space. However, Canoeboot is always expanding as it's developed.
|
||||||
|
|
||||||
|
At least 50GB of free disk space is therefor recommended.
|
||||||
|
|
||||||
|
We *actually* recommend 100GB, because Canoeboot will also have a Linux distro
|
||||||
|
in flash on a future release. On our testing, disk I/O does not seem to be a
|
||||||
|
major bottleneck, so any HDD or SSD will do, but we obviously recommend a
|
||||||
|
fast NVMe (PCI-E) SSD if you can.
|
||||||
|
|
||||||
Multi-threaded builds
|
Multi-threaded builds
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue