2021-05-18 14:21:48 +02:00
|
|
|
---
|
|
|
|
title: Code review
|
2023-10-31 03:33:36 +01:00
|
|
|
x-reviewed: true
|
2021-05-18 14:21:48 +02:00
|
|
|
...
|
|
|
|
|
2023-10-31 18:49:35 +01:00
|
|
|
Our short term plans and need for help
|
|
|
|
======================================
|
|
|
|
|
|
|
|
GNU Boot is seeking contributors for various jobs, both simple and
|
|
|
|
technical.
|
|
|
|
|
|
|
|
Information
|
|
|
|
-----------
|
|
|
|
|
|
|
|
The Libreboot name has a long history in the free software community.
|
|
|
|
Most occurrences of the uses were intended to refer to boot software
|
|
|
|
that was libre, and there is no way to edit those occurrences to refer
|
|
|
|
to libre boot software by a different name. Therefore, we need help
|
|
|
|
from the wider community to inform people about the inclusion of
|
|
|
|
nonfree software in the Libreboot releases.
|
|
|
|
|
|
|
|
Another way to help GNU Boot and take a stand for fully free software
|
|
|
|
is to change URLs across the web from <libreboot.org> to
|
|
|
|
<gnu.org/software/gnuboot>, to make sure that the mentioned software
|
|
|
|
is reliably free software.
|
|
|
|
|
|
|
|
You can also help our project by informing people about GNU boot or
|
|
|
|
other 100% free boot software.
|
|
|
|
|
|
|
|
Documentation and/or testing
|
|
|
|
----------------------------
|
|
|
|
|
|
|
|
We need help for reviewing and fixing this website (which also
|
|
|
|
contains the documentation). Many pages are inherited from Libreboot
|
|
|
|
and might be outdated or specific to Libreboot.
|
|
|
|
|
|
|
|
In addition we also need help for testing releases and
|
|
|
|
testing/updating the installation instructions.
|
|
|
|
|
|
|
|
We currently have a list of what computers aren't tested yet in the
|
|
|
|
[bug 64754](https://savannah.gnu.org/bugs/?64754).
|
|
|
|
|
|
|
|
As for reporting what you tested, you can open a new bug or send a
|
|
|
|
mail to the [gnuboot](http://lists.gnu.org/mailman/listinfo/gnuboot)
|
|
|
|
or [gnuboot-patches]
|
|
|
|
(http://lists.gnu.org/mailman/listinfo/gnuboot-patches) mailing list.
|
|
|
|
|
|
|
|
Technical contributions
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
GNU Boot is currently using old versions of upstream software (like
|
|
|
|
Coreboot, GRUB, etc) and so they need to be updated. Patches for that
|
|
|
|
need to be sent on the [gnuboot-patches]
|
|
|
|
(http://lists.gnu.org/mailman/listinfo/gnuboot-patches) mailing list.
|
|
|
|
|
|
|
|
We also have a bug tracker at
|
|
|
|
https://savannah.gnu.org/bugs/?group=gnuboot that contains a list of
|
|
|
|
bugs that needs to be fixed.
|
|
|
|
|
|
|
|
How to contribute
|
|
|
|
=================
|
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
GNU Boot repositories
|
|
|
|
---------------------
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
GNU Boot development is done using the Git version control system.
|
|
|
|
Refer to the [official Git documentation](https://git-scm.com/doc) if
|
|
|
|
you don't know how to use Git.
|
2021-11-18 18:09:23 +01:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
The main GNU Boot repository is at
|
|
|
|
<https://git.savannah.gnu.org/cgit/gnuboot.git>. It also contains the
|
|
|
|
documentation/website and code to build it.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
GNU Boot also has two additional repositories: one for [presentations
|
|
|
|
done at
|
|
|
|
conferences](https://git.savannah.gnu.org/cgit/gnuboot/presentations.git)
|
|
|
|
or for [mirroring source code that
|
|
|
|
disappeared](https://git.savannah.gnu.org/cgit/gnuboot/acpica.org-mirror.git).
|
2021-05-18 14:21:48 +02:00
|
|
|
|
|
|
|
You can download any of these repositories, make whatever changes you like, and
|
|
|
|
then submit your changes using the instructions below.
|
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
Testing your modifications
|
|
|
|
--------------------------
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
For technical contributions or for contributing to the website, you
|
|
|
|
might need to test your modifications.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
This currently requires to use a GNU/Linux distribution as building
|
|
|
|
GNU Boot or its website on other operating systems is completely
|
|
|
|
untested.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
For instructions on building GNU Boot, you can refer to the [build
|
|
|
|
instructions](docs/build/).
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
Website
|
|
|
|
-------
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
The website is in the GNU Boot source code inside the site/ directory.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
It is currently written in Markdown, specifically the Pandoc version
|
|
|
|
of it and the static HTML pages are generated with
|
|
|
|
[Untitled](https://untitled.vimuser.org/), a static website generator.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
Its documentation is in the
|
|
|
|
[README](https://git.savannah.gnu.org/cgit/gnuboot.git/tree/website-build/README)
|
|
|
|
inside the website-build directory.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
|
|
|
Name not required
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Contributions that you make are publicly recorded, in a Git repository which
|
|
|
|
everyone can access. This includes the name and email address of the
|
|
|
|
contributor.
|
|
|
|
|
|
|
|
In Git, for author name and email address, you do not have to use identifying
|
2023-10-31 03:33:36 +01:00
|
|
|
data. You can use GNU Boot Contributor and your email address could be
|
|
|
|
specified as contributor@gnuboot. You are permitted to do this, if
|
2021-05-18 14:21:48 +02:00
|
|
|
you wish to maintain privacy. We believe in privacy. If you choose to remain
|
2023-10-31 18:56:31 +01:00
|
|
|
anonymous, we will honor this.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
|
|
|
Of course, you can use whichever name and/or email address you like.
|
|
|
|
|
|
|
|
Legally speaking, all copyright is automatic under the Berne Convention of
|
|
|
|
international copyright law. It does not matter which name, or indeed whether
|
|
|
|
you even declare a copyright (but we do require that certain copyright
|
|
|
|
licenses are used - read more about that on this same page).
|
|
|
|
|
2023-10-31 03:34:27 +01:00
|
|
|
If you use a different name and email address on your commits/patches,
|
|
|
|
then you should be fairly anonymous. Use [git log git
|
2023-10-31 03:33:36 +01:00
|
|
|
\-\-pretty=fuller](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History)
|
|
|
|
and [git show \-\-pretty=fuller](https://git-scm.com/docs/git-show) to
|
2023-10-31 03:34:27 +01:00
|
|
|
confirm that before you push changes to a public Git repository.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
|
|
|
Licenses
|
|
|
|
--------
|
|
|
|
|
|
|
|
We require all patches to be submitted under a free license:
|
|
|
|
<https://www.gnu.org/licenses/license-list.html>.
|
|
|
|
|
|
|
|
- GNU General Public License v3 is highly recommended
|
|
|
|
- For documentation, we require GNU Free Documentation License v1.3 or higher
|
|
|
|
|
|
|
|
*Always* declare a license on your work! Not declaring a license means that
|
|
|
|
the default, restrictive copyright laws apply, which would make your work
|
|
|
|
non-free.
|
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
GNU/Linux is generally recommended as the OS of choice, for GNU Boot
|
|
|
|
development. However, BSD operating systems also boot on GNU Boot
|
|
|
|
machines.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-03-29 15:07:26 +02:00
|
|
|
Send patches & contribute
|
2023-10-31 03:33:36 +01:00
|
|
|
-------------------------
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-03-17 23:33:30 +01:00
|
|
|
You can submit your patches to the
|
2023-10-31 03:33:36 +01:00
|
|
|
[gnuboot-patches mailing list](https://lists.gnu.org/mailman/listinfo/gnuboot-patches),
|
2023-03-17 23:33:30 +01:00
|
|
|
preferably by using [git send-email](https://git-scm.com/docs/git-send-email).
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-03-17 23:33:30 +01:00
|
|
|
A simple guide to properly configure your git installation to send emails has
|
|
|
|
been made by [sourcehut](https://git-send-email.io/) or you can use the
|
|
|
|
[sourcehut interface](https://man.sr.ht/git.sr.ht/#sending-patches-upstream) to create patches.
|
2021-05-18 14:21:48 +02:00
|
|
|
|
2023-03-29 15:07:26 +02:00
|
|
|
You'll have to specify the mailing list address:
|
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
git config --local sendemail.to gnuboot-patches@gnu.org
|
2023-03-29 15:07:26 +02:00
|
|
|
|
|
|
|
Please also sign-off your patches, which you can configure with:
|
|
|
|
|
|
|
|
git config format.signOff yes
|
|
|
|
|
2023-10-31 03:33:36 +01:00
|
|
|
Once you have submitted your patch, the GNU Boot maintainers will be
|
|
|
|
notified via the mailing list and will start reviewing it.
|
|
|
|
|
|
|
|
Maintainers
|
|
|
|
-----------
|
|
|
|
|
2023-11-14 23:15:36 +01:00
|
|
|
Adrien 'neox' Bourmault and Denis 'GNUtoo' Carikli are the current
|
2023-10-31 03:33:36 +01:00
|
|
|
maintainers of this GNU Boot project. They will also review patches
|
|
|
|
sent to the mailing list.
|