From c8fe363ff3c9e288b9402a657fb444ce98bf4fd4 Mon Sep 17 00:00:00 2001 From: Andrea Perotti Date: Thu, 19 Oct 2023 17:14:26 +0200 Subject: [PATCH 1/2] Improved readibility for first time contributors The dedicated paragraph for the Sources makes more visible where the repo is. Improved the examples for the dependency resolution: now is clearer, without digging into srcs that ubuntu2004 is just a special case, while there's a generic target for debian based distros. --- site/docs/build/index.md | 47 ++++++++++++++++++++++++++++++---------- 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/site/docs/build/index.md b/site/docs/build/index.md index e84547a..826b0da 100644 --- a/site/docs/build/index.md +++ b/site/docs/build/index.md @@ -26,6 +26,13 @@ Introduction libreboot's build system is named `lbmk`, short for `LibreBoot MaKe`, and this document describes how to use it. With this guide, you can know how to compile libreboot from the available source code. + +The following document describes how `lbmk` works, and how you can make changes +to it: [libreboot maintenance manual](../maintain/) + +Sources +======= + This version, if hosted live on libreboot.org, assumes that you are using the `lbmk` git repository, which you can download using the instructions on [the code review page](../../git.md). @@ -35,9 +42,6 @@ documentation included with *that* release. libreboot releases are only intended as *snapshots*, not for development. For proper development, you should always be working directly in the libreboot git repository. -The following document describes how `lbmk` works, and how you can make changes -to it: [libreboot maintenance manual](../maintain/) - Git === @@ -61,8 +65,16 @@ You may also want to follow more of the steps here: Python ====== -Python2 is unused by lbmk or anything that it pulls down as modules. You -should ensure that the `python` command runs python 3, on your system. +You should ensure that the `python` command runs python 3, on your system. +Python2 is unused by lbmk or anything that it pulls down as modules. + +If building on Debian/Ubuntu based systems, you can achieve that via: + + sudo apt install python-is-python3 + +On Fedora, you can use the following + + sudo dnf install python-unversioned-command Building Libreboot ================== @@ -71,18 +83,31 @@ Actual development/testing is always done using `lbmk` directly, and this includes when building from source. Here are some instructions to get you started: -libreboot includes a script that automatically installs apt-get dependencies -in Ubuntu 20.04 and distros based upon it: +libreboot includes a script that automatically installs build dependencies +according to the selected linux distro. +The currently supported distros are: Debian/Ubuntu/Linux Mint/Pop!\_OS, +Fedora, Arch Linux/Parabola or Void Linux. - sudo ./build dependencies ubuntu2004 +Some examples: -Separate scripts also exist: + sudo ./build dependencies ubuntu + + sudo ./build dependencies debian - sudo ./build dependencies arch + - sudo ./build dependencies void + sudo ./build dependencies fedora38 + + + + sudo ./build dependencies arch + +NOTE: In case of Ubuntu 20.04 LTS or derived distros, use the dedicated + configuration file: + + sudo ./build dependencies ubuntu2004 Check: `config/dependencies/` for list of supported distros. From 95710d9faf3babd3057cc1b5875e737be4da9606 Mon Sep 17 00:00:00 2001 From: Andrea Perotti Date: Thu, 19 Oct 2023 17:51:36 +0200 Subject: [PATCH 2/2] Small md syntax fixes --- site/docs/build/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/site/docs/build/index.md b/site/docs/build/index.md index 826b0da..139b853 100644 --- a/site/docs/build/index.md +++ b/site/docs/build/index.md @@ -92,20 +92,20 @@ Some examples: sudo ./build dependencies ubuntu - +or - sudo ./build dependencies debian + sudo ./build dependencies debian - +or sudo ./build dependencies fedora38 - +or sudo ./build dependencies arch -NOTE: In case of Ubuntu 20.04 LTS or derived distros, use the dedicated - configuration file: +NOTE: In case of Ubuntu 20.04 LTS or derived distros for that specific release, + use the dedicated configuration file: sudo ./build dependencies ubuntu2004