aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/contributing/hacking.md
diff options
context:
space:
mode:
authorJade Lovelace <lix@jade.fyi>2024-05-05 15:32:20 -0700
committerJade Lovelace <lix@jade.fyi>2024-05-05 16:11:01 -0700
commit748d8310fa7e044ad4c950ff38e31309ea3f606d (patch)
tree4a097ffd7a05e17f7b4a55660abff765e0346e11 /doc/manual/src/contributing/hacking.md
parenta3d4aca83691eb4bcbc2d3b20b559dbd59f02887 (diff)
Fix the pages in the manual for Lix
This doesn't comprehensively fix everything outdated in the manual, or make the manual greatly better, but it does note down where at least jade noticed it was wrong, and it does fix all the instances of referencing Nix to conform to the style guide to the best of our ability. A lot of things have been commented out for being wrong, and there are three types of FIXME introduced: - FIXME(Lix): generically Lix needs to fix it - FIXME(Qyriad): re https://git.lix.systems/lix-project/lix/issues/215 - FIXME(meson): docs got outdated by meson changes and need rewriting I did fix a bunch of it that I could, but there could certainly be mistakes and this is definitely just an incremental improvement. Fixes: https://git.lix.systems/lix-project/lix/issues/266 Change-Id: I5993c4603d7f026a887089fce77db08394362135
Diffstat (limited to 'doc/manual/src/contributing/hacking.md')
-rw-r--r--doc/manual/src/contributing/hacking.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md
index a7d707438..a8591e7ca 100644
--- a/doc/manual/src/contributing/hacking.md
+++ b/doc/manual/src/contributing/hacking.md
@@ -1,6 +1,6 @@
# Hacking
-This section provides some notes on how to hack on Nix. To get the latest version of Lix from Forgejo:
+This section provides some notes on how to hack on Lix. To get the latest version of Lix from Forgejo:
```console
$ git clone https://git.lix.systems/lix-project/lix
@@ -120,13 +120,13 @@ $ meson introspect
## Building Lix outside of development shells
-To build a release version of Nix for the current operating system and CPU architecture:
+To build a release version of Lix for the current operating system and CPU architecture:
```console
$ nix build
```
-You can also build Nix for one of the [supported platforms](#platforms).
+You can also build Lix for one of the [supported platforms](#platforms).
> **Note**
>
@@ -135,7 +135,7 @@ You can also build Nix for one of the [supported platforms](#platforms).
## Platforms
-Nix can be built for various platforms, as specified in [`flake.nix`]:
+Lix can be built for various platforms, as specified in [`flake.nix`]:
[`flake.nix`]: https://github.com/nixos/nix/blob/master/flake.nix
@@ -147,7 +147,7 @@ Nix can be built for various platforms, as specified in [`flake.nix`]:
- `armv6l-linux`
- `armv7l-linux`
-In order to build Nix for a different platform than the one you're currently
+In order to build Lix for a different platform than the one you're currently
on, you need a way for your current Nix installation to build code for that
platform. Common solutions include [remote builders] and [binary format emulation]
(only supported on NixOS).
@@ -196,7 +196,7 @@ Lix uses a string with the following format to identify the *system type* or *pl
<cpu>-<os>[-<abi>]
```
-It is set when Nix is compiled for the given system, and determined by [Meson's `host_machine.cpu_family()` and `host_machine.system()` values](https://mesonbuild.com/Reference-manual_builtin_host_machine.html).
+It is set when Lix is compiled for the given system, and determined by [Meson's `host_machine.cpu_family()` and `host_machine.system()` values](https://mesonbuild.com/Reference-manual_builtin_host_machine.html).
For historic reasons and backward-compatibility, some CPU and OS identifiers are translated from the GNU Autotools naming convention in [`meson.build`](https://git.lix.systems/lix-project/lix/blob/main/meson.build) as follows:
@@ -212,7 +212,7 @@ For historic reasons and backward-compatibility, some CPU and OS identifiers are
## Compilation environments
-Nix can be compiled using multiple environments:
+Lix can be compiled using multiple environments:
- `stdenv`: default;
- `gccStdenv`: force the use of `gcc` compiler;
@@ -325,8 +325,13 @@ Here's what a complete entry looks like. The file name is not incorporated in th
```
---
synopsis: Basically a title
-issues: 1234
+# 1234 or gh#1234 will refer to CppNix GitHub, fj#1234 will refer to a Lix forgejo issue.
+issues: [1234, fj#1234]
+# Use this *only* if there is a CppNix pull request associated with this change
prs: 1238
+# List of Lix Gerrit changelist numbers; if there is an associated Lix GitHub
+# PR, just put in the Gerrit CL number.
+cls: [123]
---
Here's one or more paragraphs that describe the change.