doc/outline.txt

   1 - The standard environment
   2
   3   (Some of this can be moved from the Nix manual)
   4
   5   - Special attributes
   6
   7   - Generic builder
   8
   9   - Helper functions
  10
  11   - GCC / ld wrapper (+ env vars)
  12
  13   - Phases (+ how to add phases) and hooks
  14
  15   - Override functions for stdenv
  16
  17     - Overriding GCC
  18
  19     - Overriding the setup script
  20
  21     - Predefined override functions in all-packages.nix: static binary
  22       stdenv, dietlibc stdenv
  23
  24   - Stdenv bootstrap; how to update the Linux bootstrap binaries
  25
  26   - Specific platform notes (Linux, Native, Cygwin, Mingw)
  27
  28
  29 - Support for specific languages
  30
  31   - Perl
  32
  33     - Generic Perl builder
  34
  35   - Python
  36
  37     - Wrapper generation
  38
  39   - Haskell
  40
  41     - TODO
  42
  43   - Java
  44
  45     - TODO; Java needs lots of improvement
  46
  47   - TeX/LaTeX
  48
  49     - Special support for building TeX documents
  50
  51
  52 - Special kinds of applications
  53
  54   - OpenGL apps
  55
  56   - Binary-only apps
  57
  58   - Linux kernel modules
  59
  60   - Mozilla plugins/extensions
  61
  62   - X apps
  63
  64   - KDE apps
  65
  66   - GConf-based apps
  67
  68   - Programs that need wrappers
  69
  70     - makeWrapper etc.
  71
  72   - Initial ramdisks
  73
  74
  75 - Library functions
  76
  77   - i.e. in lib/default.nix
  78
  79
  80 - Specific package notes
  81
  82   - Linux kernel; how to update; feature tests
  83
  84   - X.org; how to update
  85
  86   - Gnome; how to update
  87
  88   - GCC?
  89
  90   - GHC?
  91
  92   - ...
  93
  94
  95 - Meta attributes
  96
  97   - License attr; possible values
  98
  99
 100 - Virtual machine support (for the build farm)
 101
 102   - vmtools
 103
 104   - KVM notes
 105
 106   - Performing a build in a VM
 107
 108     - In the host FS
 109
 110     - In a disk image
 111
 112   - RPM builds
 113
 114     - RPM image creation
 115
 116   - Deb builds
 117
 118     - Deb image creation
 119
 120   - Debugging VM builds
 121
 122
 123 - Guidelines for Nixpkgs contributions
 124
 125   - File naming conventions
 126
 127     - Versioning of packages
 128
 129   - Tree organisation
 130
 131   - Variable naming
 132
 133   - Layout / indentations style
 134
 135   - Output FS hierarchy (e.g. $out/share/man instead of $out/man)
 136
 137
 138 - Misc
 139
 140   - Building outside of the Nixpkgs tree
 141
 142   - Config options
 143
 144   - Downloading stuff
 145
 146     - fetchurl
 147
 148       - mirror:// scheme
 149
 150     - fetchsvn
 151
 152     - fetchcvs
 153
 154     - fetchdarcs
 155
 156
 157 - Appendix: Nixpkgs config options
 158