Reworked git.md, correct repositories, mailing lists
Signed-off-by: Adrien 'neox' Bourmault <neox@gnu.org>
This commit is contained in:
parent
59382295b1
commit
91cf53a27b
GPG Key ID:
5F5DFCC14177E263
85
site/git.md
85
site/git.md
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Code review
|
title: Code review
|
||||||
x-reviewed: true
|
x-toc-enable: true
|
||||||
...
|
...
|
||||||
|
|
||||||
Our short term plans and need for help
|
Our short term plans and need for help
|
||||||
|
|
@ -61,50 +61,73 @@ How to contribute
|
||||||
=================
|
=================
|
||||||
|
|
||||||
GNU Boot repositories
|
GNU Boot repositories
|
||||||
---------------------
|
======================
|
||||||
|
|
||||||
GNU Boot development is done using the Git version control system.
|
Information about who works on GNU Boot and who runs the project can be
|
||||||
Refer to the [official Git documentation](https://git-scm.com/doc) if
|
found on [who.md](who.md)
|
||||||
you don't know how to use Git.
|
|
||||||
|
|
||||||
The main GNU Boot repository is at
|
GNU Boot has three Git repositories:
|
||||||
<https://git.savannah.gnu.org/cgit/gnuboot.git>. It also contains the
|
|
||||||
documentation/website and code to build it.
|
|
||||||
|
|
||||||
GNU Boot also has two additional repositories: one for [presentations
|
* Build system and website (+docs): <https://git.savannah.gnu.org/git/gnuboot.git>
|
||||||
done at
|
* ACPICA mirror: <https://git.savannah.gnu.org/git/gnuboot/acpica.org-mirror.git>
|
||||||
conferences](https://git.savannah.gnu.org/cgit/gnuboot/presentations.git)
|
* Untitled mirror: <https://git.savannah.gnu.org/git/gnuboot/untitled-mirror.git>
|
||||||
or for [mirroring source code that
|
|
||||||
disappeared](https://git.savannah.gnu.org/cgit/gnuboot/acpica.org-mirror.git).
|
|
||||||
|
|
||||||
You can download any of these repositories, make whatever changes you like, and
|
You can download any of these repositories, make whatever changes you like, and
|
||||||
then submit your changes using the instructions below.
|
then submit your changes using the instructions below.
|
||||||
|
|
||||||
Testing your modifications
|
It is recommended that you build GNU Boot (all parts of it) in a GNU+Linux
|
||||||
--------------------------
|
distribution. For example, the build system is untested on BSD systems.
|
||||||
|
Install `git` in your GNU+Linux system, and download one of the repositories.
|
||||||
|
|
||||||
For technical contributions or for contributing to the website, you
|
GNU Boot development is done using the Git version control system.
|
||||||
might need to test your modifications.
|
Refer to the [official Git documentation](https://git-scm.com/doc) if you don't
|
||||||
|
know how to use Git.
|
||||||
|
|
||||||
This currently requires to use a GNU/Linux distribution as building
|
Send patches
|
||||||
GNU Boot or its website on other operating systems is completely
|
------------
|
||||||
untested.
|
|
||||||
|
|
||||||
For instructions on building GNU Boot, you can refer to the [build
|
You can submit patches by email to the
|
||||||
instructions](docs/build/).
|
[patches mailing list](http://lists.gnu.org/mailman/listinfo/gnuboot-patches) or via
|
||||||
|
[our patch tracker](https://savannah.gnu.org/patch/?group=gnuboot&func=additem).
|
||||||
|
|
||||||
Website
|
|
||||||
-------
|
|
||||||
|
|
||||||
The website is in the GNU Boot source code inside the site/ directory.
|
Send bug reports
|
||||||
|
----------------
|
||||||
|
|
||||||
It is currently written in Markdown, specifically the Pandoc version
|
You can submit bug reports by email to the
|
||||||
of it and the static HTML pages are generated with
|
[bug mailing list](http://lists.gnu.org/mailman/listinfo/bug-gnuboot) or via
|
||||||
[Untitled](https://untitled.vimuser.org/), a static website generator.
|
[our bug tracker](https://savannah.gnu.org/bugs/?group=gnuboot&func=additem).
|
||||||
|
|
||||||
Its documentation is in the
|
|
||||||
[README](https://git.savannah.gnu.org/cgit/gnuboot.git/tree/website-build/README)
|
Build system
|
||||||
inside the website-build directory.
|
---------------------
|
||||||
|
|
||||||
|
This is the core build system in GNU Boot. You could say that it *is*
|
||||||
|
GNU Boot! Download the Git repository:
|
||||||
|
|
||||||
|
git clone https://git.savannah.gnu.org/git/gnuboot.git
|
||||||
|
|
||||||
|
The `git` command, seen above, will download the build system `lbmk`.
|
||||||
|
You can then go into it like so:
|
||||||
|
|
||||||
|
cd gnuboot
|
||||||
|
|
||||||
|
Make whatever changes you like, or simply build it. For instructions on how to
|
||||||
|
build, refer to the [build instructions](docs/build/).
|
||||||
|
|
||||||
|
Information about the build system itself, and how it works, is available in
|
||||||
|
the [lbmk maintenance guide](docs/maintain/).
|
||||||
|
|
||||||
|
Website and docs
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Make whatever changes you like. See notes below about how to send patches.
|
||||||
|
|
||||||
|
The entire website is written in Markdown, specifically the Pandoc version of
|
||||||
|
it. The static HTML pages are generated with [Untitled](https://untitled.vimuser.org/).
|
||||||
|
|
||||||
|
If you like, you can set up a local HTTP server and build your own local
|
||||||
|
version of the website.
|
||||||
|
|
||||||
Name not required
|
Name not required
|
||||||
-----------------
|
-----------------
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue