Commit Graph
36 Commits
Author SHA1 Message Date
Maximilian BoschandGitHub 3655875483 doc/manual: update hacking docs (#4078)
* By default, build artifacts should be installed into `outputs/` rather
  than `inst/`[1].
* Add instructions on how to run unit-tests.

[1] 733d2e9402
2020-09-27 20:35:03 +00:00
Bryan Richter 5fe375a8f1 nix-prefetch-url: Add --executable flag
pkgs.fetchurl supports an executable argument, which is especially nice
when downloading a large executable. This patch adds the same option to
nix-prefetch-url.

I have tested this to work on the simple case of prefetching a little
executable:

1. nix-prefetch-url --executable https://my/little/script
2. Paste the hash into a pkgs.fetchurl-based package, script-pkg.nix
3. Delete the output from the store to avoid any misidentified artifacts
4. Realise the package script-pkg.nix
5. Run the executable

I repeated the above while using --name, as well.

I suspect --executable would have no meaningful effect if combined with
--unpack, but I have not tried it.
2020-09-18 19:09:45 +03:00
7cb5f643a6 docs+test: fix remaining installer downloads without -L (#4006)
Co-authored-by: lf- <lf-@users.noreply.github.com>
2020-09-12 22:08:40 +02:00
Vladimír ČunátandGitHub 77d4758cf2 Merge #3982: Minor docs updates 2020-09-07 21:54:59 +02:00
Eelco Dolstra 00d25e8457 Remove the --indirect flag
All GC roots are now indirect.
2020-09-03 11:22:00 +02:00
Cole Helbling a72ed3e8a1 hacking.md: add --prefix flag to configure
Otherwise, the steps advertised in this document won't actually work
(e.g. `make install` will fail, trying to access /usr, and
`./inst/bin/nix` won't exist).
2020-09-01 12:06:02 -07:00
Eelco Dolstra 84f5cabbea Merge remote-tracking branch 'origin/master' into markdown 2020-08-31 14:24:26 +02:00
Eelco Dolstra 7a02865b94 Move import docs 2020-08-25 14:06:01 +02:00
Eelco Dolstra 0f314f3c25 Generate builtins section of the manual 2020-08-24 14:49:30 +02:00
Eelco Dolstra a990f063ff Move primop docs inline
This makes them available to 'nix repl'.
2020-08-24 14:31:10 +02:00
Eelco Dolstra 33b1679d75 Allow primops to have Markdown documentation 2020-08-24 13:16:02 +02:00
Eelco Dolstra c8fa39324a Generate the nix.conf docs from the source code
This means we don't have two (divergent) sets of option descriptions
anymore.
2020-08-19 18:28:04 +02:00
Eelco Dolstra 6f19c776db Start generation of the nix.1 manpage 2020-08-17 19:33:18 +02:00
Eelco Dolstra 7cdc739ece Merge remote-tracking branch 'origin/master' into markdown 2020-08-17 13:43:39 +02:00
Eelco Dolstra bf290c2306 Merge remote-tracking branch 'origin/master' into markdown 2020-07-31 16:07:04 +02:00
Eelco Dolstra 2ae9ac2369 console -> shell 2020-07-31 16:02:37 +02:00
Eelco Dolstra 1d0a7b54fa Enable syntax highlighting 2020-07-31 15:43:25 +02:00
Eelco Dolstra 05a282295f Fix internal links 2020-07-24 15:46:16 +02:00
Eelco Dolstra da3d776cb9 Fix some dangling references 2020-07-24 14:31:33 +02:00
Eelco Dolstra 4a79b3598f Fix nix-copy-closure manpage 2020-07-24 13:01:00 +02:00
Eelco Dolstra 7a0e6f076a Move figures 2020-07-24 12:58:31 +02:00
Eelco Dolstra 758c9ee1bb Clean up the manpages 2020-07-24 12:56:19 +02:00
Eelco Dolstra 8d0b311a1c Get rid of footnotes
Markdown doesn't support them.
2020-07-24 11:43:44 +02:00
Eelco Dolstra 69333cb62c Sigh 2020-07-23 18:27:20 +02:00
Eelco Dolstra 802150f987 <replaceable> -> <emphasis>
Pandoc doesn't know <replaceable> so let's force it to be rendered as
italics.
2020-07-23 18:27:20 +02:00
Eelco Dolstra ee05108472 <simplesect> -> <section>
Pandoc silently ignores <simplesect>...
2020-07-23 18:27:20 +02:00
Eelco Dolstra 136fd55bb2 Get rid of <figure> 2020-07-23 18:27:20 +02:00
Eelco Dolstra ca130b73a0 Get rid of <example>
Markdown doesn't have floats so we can't have this.
2020-07-23 18:27:20 +02:00
Eelco Dolstra 13df1faf25 Get rid of callouts since Markdown doesn't support them 2020-07-23 18:27:20 +02:00
Eelco Dolstra 504b7abc45 Convert commands 2020-07-23 18:27:12 +02:00
Eelco Dolstra efdb89994c Convert nix.conf manpage 2020-07-23 18:27:11 +02:00
Eelco Dolstra f390303566 Reconvert 2020-07-23 18:27:11 +02:00
Eelco Dolstra 942cd687f9 Remove libxml2 / libxslt prerequisites 2020-07-23 18:26:48 +02:00
Eelco Dolstra ef606760ab Pandoc conversion 2020-07-23 18:26:48 +02:00
Eelco Dolstra d004715665 Fix link 2020-07-23 18:26:48 +02:00
Eelco Dolstra e0ea3c82ca Use mdbook 2020-07-23 18:26:48 +02:00