guiwf/lix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
9,824 Commits 37 Branches 40 Tags
4f3e7f4eec9ef5fb86aea9f745a3574cc5cfae28
Commit Graph
52 Commits
Author SHA1 Message Date
Rok Garbas 7de4b1e9aa smaller fixes 2020-12-17 23:42:49 +01:00
Rok Garbas ae77f21474 Switch away from classification as Tier1-3 
to classification to a more descriptive classification.
 2020-12-08 11:59:23 +01:00
Rok Garbas 0d7714b0d7 forgot to add the files 2020-12-08 10:25:03 +01:00
Rok Garbas 24db5b125f Merge remote-tracking branch 'origin/master' into cli-guideline 2020-12-07 15:13:36 +01:00
Eelco Dolstra 72428e38d9 Generate separate manpages for each nix subcommand 2020-12-02 23:23:23 +01:00
Rok Garbas 44da19f73c Adds Nix CLI Guideline to docs 
As we are working towards Nix 3.0 we want to make sure that we make a
huge step forward in Nix's user experience. And once 3.0 is out of the
door we need to make sure that all future commands and features keep up
the standard of user experience.

This PR adds a CLI guideline document to the Nix documentation. Consider
this document a good starting point and a checklist when somebody will
be (re)implementing commands.

Clearly this guideline does nothing to improve user experience on its
own and can only be useful as long as it is going to be read and
cared for. But it is a first step into that direction.
 2020-12-02 17:00:32 +01:00
mkenigsandGitHub 8b15650e74 docs: consistent console prompt (#4213) 
Everywhere else a $ is used
 2020-11-02 16:32:05 +01:00
Eelco DolstraandGitHub a3a22bd804 Merge pull request #4202 from hercules-ci/nix-shell-doc 
Nix shell doc
 2020-10-30 11:36:24 +01:00
Robert Hensing d4c5d8d32a nix-shell.md: Extend shellHook example 2020-10-30 11:12:28 +01:00
Robert Hensing b809c48ebb nix-shell.md: evaluated -> run 
Use "run" to avoid confusion with Nix evaluation.
"evaluated" was intended to reference bash eval but it's ambiguous.
 2020-10-30 11:01:33 +01:00
Eelco Dolstra ff4dea63c9 Generalize extra-* settings 
This removes the extra-substituters and extra-sandbox-paths settings
and instead makes every array setting extensible by setting
"extra-<name> = <value>" in the configuration file or passing
"--<name> <value>" on the command line.
 2020-10-29 18:17:39 +01:00
tniasandGitHub c189cf7e33 Add sha512 to hashAlgo listings in manpages (#4186) 2020-10-25 22:16:53 +00:00
Josef Kemetmüller 7f60f48e1a Fix the docs about the new NIX_CONFIG env var 
This was accidentally documented as NIX_OPTIONS.
 2020-10-21 17:04:36 +02:00
Christian Kampka 461cf2b856 Add NIX_CONFIG env var for applying nix.conf overrides 2020-10-21 13:41:26 +02:00
Stefan Frijters a53438d18f doc: nix-shell in pure mode does *not* source user bashrc 2020-10-18 14:26:05 +02:00
Eelco Dolstra 58dadf2954 Remove stray 'Title:' from the manual 
Closes #4096.
 2020-10-08 17:30:40 +02:00
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
JadeGitHublf-
 		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