Unverified Commit 8a977098 authored by quantenzitrone's avatar quantenzitrone
Browse files

docs: remove references to the xorg namespace

parent 98097c5c
Loading
Loading
Loading
Loading
+3 −5
Original line number Diff line number Diff line
@@ -47,11 +47,9 @@ You can create a simple environment using a `shell.nix` like this:
    (with pkgs; [
      udev
      alsa-lib
    ])
    ++ (with pkgs.xorg; [
      libX11
      libXcursor
      libXrandr
      libx11
      libxcursor
      libxrandr
    ]);
  multiPkgs =
    pkgs:
+0 −1
Original line number Diff line number Diff line
@@ -32,7 +32,6 @@ cataclysm-dda.section.md
urxvt.section.md
vcpkg.section.md
weechat.section.md
xorg.section.md
uv.section.md
build-support.md
```

doc/packages/xorg.section.md

deleted100644 → 0
+0 −34
Original line number Diff line number Diff line
# X.org {#sec-xorg}

The Nix expressions for the X.org packages reside in `pkgs/servers/x11/xorg/default.nix`. This file is automatically generated from lists of tarballs in an X.org release. As such, it should not be modified directly; rather, you should modify the lists, the generator script, or the file `pkgs/servers/x11/xorg/overrides.nix`, in which you can override or add to the derivations produced by the generator.

## Katamari Tarballs {#katamari-tarballs}

X.org upstream releases used to include [katamari](https://en.wiktionary.org/wiki/%E3%81%8B%E3%81%9F%E3%81%BE%E3%82%8A) releases, which included a holistic recommended version for each tarball, up until 7.7. To create a list of tarballs in a katamari release:

```ShellSession
export release="X11R7.7"
export url="mirror://xorg/$release/src/everything/"
cat $(PRINT_PATH=1 nix-prefetch-url $url | tail -n 1) \
  | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'url'}$2\n"; }; }' \
  | sort > "tarballs-$release.list"
```

## Individual Tarballs {#individual-tarballs}

The upstream release process for [X11R7.8](https://x.org/wiki/Releases/7.8/) does not include a planned katamari. Instead, each component of X.org is released as its own tarball. We maintain `pkgs/servers/x11/xorg/tarballs.list` as a list of tarballs for each individual package. This list includes X.org core libraries and protocol descriptions, extra newer X11 interface libraries, like `xorg.libxcb`, and classic utilities which are largely unused but still available if needed, like `xorg.imake`.

## Generating Nix Expressions {#generating-nix-expressions}

The generator is invoked as follows:

```ShellSession
cd pkgs/servers/x11/xorg
<tarballs.list perl ./generate-expr-from-tarballs.pl
```

For each of the tarballs in the `.list` files, the script downloads it, unpacks it, and searches its `configure.ac` and `*.pc.in` files for dependencies. This information is used to generate `default.nix`. The generator caches downloaded tarballs between runs. Pay close attention to the `NOT FOUND: $NAME` messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.)

## Overriding the Generator {#overriding-the-generator}

If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, `patches` or a `postInstall` hook), you should modify `pkgs/servers/x11/xorg/overrides.nix`.
+6 −16
Original line number Diff line number Diff line
@@ -311,7 +311,12 @@
    "release-notes.html#sec-nixpkgs-release-26.05-highlights"
  ],
  "sec-nixpkgs-release-26.05-incompatibilities": [
    "release-notes.html#sec-nixpkgs-release-26.05-incompatibilities"
    "release-notes.html#sec-nixpkgs-release-26.05-incompatibilities",
    "index.html#sec-xorg",
    "index.html#katamari-tarballs",
    "index.html#individual-tarballs",
    "index.html#generating-nix-expressions",
    "index.html#overriding-the-generator"
  ],
  "sec-nixpkgs-release-26.05-lib": [
    "release-notes.html#sec-nixpkgs-release-26.05-lib"
@@ -4495,21 +4500,6 @@
  "sec-weechat": [
    "index.html#sec-weechat"
  ],
  "sec-xorg": [
    "index.html#sec-xorg"
  ],
  "katamari-tarballs": [
    "index.html#katamari-tarballs"
  ],
  "individual-tarballs": [
    "index.html#individual-tarballs"
  ],
  "generating-nix-expressions": [
    "index.html#generating-nix-expressions"
  ],
  "overriding-the-generator": [
    "index.html#overriding-the-generator"
  ],
  "sec-build-support": [
    "index.html#sec-build-support"
  ],
+2 −0
Original line number Diff line number Diff line
@@ -78,6 +78,8 @@

- `iroh` has been removed and split up into `iroh-dns-server` and `iroh-relay`.

- the `xorg` package set has been deprecated and will be removed, packages have moved to the top level.

- `python3Packages.pygame` has been been renamed to `python3Packages.pygame-original`, the attribute `python3Packages.pygame` will from python 3.14 default to the more actively maintained `python3Packages.pygame-ce`

- `python3Packages.gradio` has been updated to version 6. See upstream's migration guide at https://www.gradio.app/main/guides/gradio-6-migration-guide.
Loading