From 91cf53a27b3c4887ab985fad40a25e2bc500fa2e Mon Sep 17 00:00:00 2001 From: Adrien 'neox' Bourmault Date: Tue, 29 Aug 2023 16:50:56 +0200 Subject: [PATCH] Reworked git.md, correct repositories, mailing lists Signed-off-by: Adrien 'neox' Bourmault --- site/git.md | 85 ++++++++++++++++++++++++++++++++++------------------- 1 file changed, 54 insertions(+), 31 deletions(-) diff --git a/site/git.md b/site/git.md index 86b73bb..457b0f4 100644 --- a/site/git.md +++ b/site/git.md @@ -1,6 +1,6 @@ --- title: Code review -x-reviewed: true +x-toc-enable: true ... Our short term plans and need for help @@ -61,50 +61,73 @@ How to contribute ================= GNU Boot repositories ---------------------- +====================== -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. +Information about who works on GNU Boot and who runs the project can be +found on [who.md](who.md) -The main GNU Boot repository is at -. It also contains the -documentation/website and code to build it. +GNU Boot has three Git repositories: -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). +* Build system and website (+docs): +* ACPICA mirror: +* Untitled mirror: You can download any of these repositories, make whatever changes you like, and 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 -might need to test your modifications. +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. -This currently requires to use a GNU/Linux distribution as building -GNU Boot or its website on other operating systems is completely -untested. +Send patches +------------ -For instructions on building GNU Boot, you can refer to the [build -instructions](docs/build/). +You can submit patches by email to the +[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 -of it and the static HTML pages are generated with -[Untitled](https://untitled.vimuser.org/), a static website generator. +You can submit bug reports by email to the +[bug mailing list](http://lists.gnu.org/mailman/listinfo/bug-gnuboot) or via +[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) -inside the website-build directory. + +Build system +--------------------- + +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 -----------------