diff options
author | Corbin <cds@corbinsimpson.com> | 2020-11-30 09:36:18 -0800 |
---|---|---|
committer | Corbin <cds@corbinsimpson.com> | 2020-11-30 21:55:39 -0800 |
commit | e0fbc4d14caff569c06bdd1ff9bc9f8fe4ebca41 (patch) | |
tree | 9002e6356df6ad2c7a51c14abc582b90a7c3dd51 /doc/builders | |
parent | 6c407c7077f92b8fc9258389af4cf52ca9a79378 (diff) |
doc/builders/packages/xorg: Convert to CommonMark.
I had to pick 7.4 or 7.5. I picked 7.4 for now.
Diffstat (limited to 'doc/builders')
-rw-r--r-- | doc/builders/packages/index.xml | 2 | ||||
-rw-r--r-- | doc/builders/packages/xorg.section.md | 41 | ||||
-rw-r--r-- | doc/builders/packages/xorg.xml | 34 |
3 files changed, 42 insertions, 35 deletions
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index d967718cab39..3007c297c163 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -21,5 +21,5 @@ <xi:include href="cataclysm-dda.section.xml" /> <xi:include href="urxvt.xml" /> <xi:include href="weechat.section.xml" /> - <xi:include href="xorg.xml" /> + <xi:include href="xorg.section.xml" /> </chapter> diff --git a/doc/builders/packages/xorg.section.md b/doc/builders/packages/xorg.section.md new file mode 100644 index 000000000000..c8a4c1219818 --- /dev/null +++ b/doc/builders/packages/xorg.section.md @@ -0,0 +1,41 @@ +# 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. + +The generator is invoked as follows: + +```sh +cd pkgs/servers/x11/xorg +cat tarballs-7.4.list extra.list old.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.) + +A file like `tarballs-7.4.list` contains all tarballs in a X.org release. It +can be generated like this: + +```sh +export i="mirror://xorg/X11R7.4/src/everything/" +cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ + | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \ + | sort > tarballs-7.4.list +``` + +`extra.list` contains libraries that aren’t part of X.org proper, but are +closely related to it, such as `libxcb`. `old.list` contains some packages +that were removed from X.org, but are still needed by some people or by other +packages (such as `imake`). + +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`. diff --git a/doc/builders/packages/xorg.xml b/doc/builders/packages/xorg.xml deleted file mode 100644 index ebf4930cc097..000000000000 --- a/doc/builders/packages/xorg.xml +++ /dev/null @@ -1,34 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xml:id="sec-xorg"> - <title>X.org</title> - - <para> - The Nix expressions for the X.org packages reside in <filename>pkgs/servers/x11/xorg/default.nix</filename>. 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 <filename>pkgs/servers/x11/xorg/overrides.nix</filename>, in which you can override or add to the derivations produced by the generator. - </para> - - <para> - The generator is invoked as follows: -<screen> -<prompt>$ </prompt>cd pkgs/servers/x11/xorg -<prompt>$ </prompt>cat tarballs-7.5.list extra.list old.list \ - | perl ./generate-expr-from-tarballs.pl -</screen> - For each of the tarballs in the <filename>.list</filename> files, the script downloads it, unpacks it, and searches its <filename>configure.ac</filename> and <filename>*.pc.in</filename> files for dependencies. This information is used to generate <filename>default.nix</filename>. The generator caches downloaded tarballs between runs. Pay close attention to the <literal>NOT FOUND: <replaceable>name</replaceable></literal> messages at the end of the run, since they may indicate missing dependencies. (Some might be optional dependencies, however.) - </para> - - <para> - A file like <filename>tarballs-7.5.list</filename> contains all tarballs in a X.org release. It can be generated like this: -<screen> -<prompt>$ </prompt>export i="mirror://xorg/X11R7.4/src/everything/" -<prompt>$ </prompt>cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \ - | perl -e 'while (<>) { if (/(href|HREF)="([^"]*.bz2)"/) { print "$ENV{'i'}$2\n"; }; }' \ - | sort > tarballs-7.4.list -</screen> - <filename>extra.list</filename> contains libraries that aren’t part of X.org proper, but are closely related to it, such as <literal>libxcb</literal>. <filename>old.list</filename> contains some packages that were removed from X.org, but are still needed by some people or by other packages (such as <varname>imake</varname>). - </para> - - <para> - If the expression for a package requires derivation attributes that the generator cannot figure out automatically (say, <varname>patches</varname> or a <varname>postInstall</varname> hook), you should modify <filename>pkgs/servers/x11/xorg/overrides.nix</filename>. - </para> -</section> |