nordic-dev.net/nix
nordic-dev.net/nix
2
0
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2024-11-29 02:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
18,325 Commits 201 Branches 183 Tags 141 MiB
9c0e968843
Commit Graph

105 Commits

Author SHA1 Message Date
Eelco Dolstra
49a932fb18 nix --help: Display help using lowdown instead of man 
Fixes #4476.
Fixes #5231.
 2021-09-13 14:45:21 +02:00
Eelco Dolstra
ff03fb6743 Manual: Depend on all *.md files 2021-09-09 15:01:19 +02:00
Sergei Trofimovich
33fa5f3cd9 doc/manual/local.mk: fix 'make install DESTDIR=...' 
Install failure is observed when we try to install
into inplace location as non-root:

```
$ LANG=C make install DESTDIR=$PWD/__i__ V=1
RUST_LOG=warn mdbook build doc/manual -d /usr/share/doc/nix/manual
2021-08-28 13:29:58 [ERROR] (mdbook::utils): Error: Rendering failed
2021-08-28 13:29:58 [ERROR] (mdbook::utils):    Caused By: Unexpected error when constructing destination path
2021-08-28 13:29:58 [ERROR] (mdbook::utils):    Caused By: Permission denied (os error 13)
make: *** [doc/manual/local.mk:98: /usr/share/doc/nix/manual/index.html] Error 101
```

The change is to prefix paths with `$(DESTDIR)`.
 2021-08-28 13:31:34 +01:00
Eelco Dolstra
d64f9671fc
Merge pull request #5094 from Pamplemousse/simpler_doc 
doc/manual: don't need to copy `highlight.js` manually
 2021-08-05 15:13:07 +02:00
Pamplemousse
de39cfb9f3 doc/manual: don't need to copy highlight.js manually 
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
 2021-08-04 19:47:05 -07:00
regnat
441be5d59a Remove dead code in doc’s local.mk 2021-07-27 14:37:55 +02:00
regnat
cd6e9eb024 Fix the generation of nix3 manpages 
- Separate the generation of the manpages from their installation
- Make sure that `make` generates the manpages
- Make sure that `make install` installs them

Fix #5051
 2021-07-27 13:47:53 +02:00
regnat
c5f5d615a6 Cleanup the generation of the nix3 manpages 
Use a dedicated make target for the man page rather than bundling the
generation as part of `install`.
Also make sure that `make install` is a fixpoint by

- Removing the generated markdown files from `MANUAL_SRCS`
- Not having the manpage generation write in its source directory so as
  to not update its timestamp (it would run each time otherwise)
 2021-07-19 16:55:56 +02:00
Alyssa Ross
5f07f2ff2b
doc: builtins: use a definition list 
This looks a lot better (and is also more semantically meaningful).

Since this list is generated in a Nix expression, I don't think using
HTML here is going to be the thing that puts people off modifying this
part of the documentation!
 2021-05-05 14:34:46 +00:00
Eelco Dolstra
e65f604ea9 Set more man sections 2021-04-23 14:20:28 +02:00
Alyssa Ross
29132f99c5
doc: fix section in nix3 man page metadata 
These man pages said they were in section 7, even though we were
installing them to section 1 (which is the right place for them).
 2021-04-23 10:52:54 +00:00
regnat
5f66edf245 Make make install less noisy 
Remove the printing and useless output of a couple of commands when running `make install`
 2020-12-04 14:50:47 +01:00
Eelco Dolstra
8ad2c9c4b9 Remove 'dist' target 
We're not producing source tarballs anymore so this has been
bitrotting.
 2020-12-03 16:17:58 +01:00
Eelco Dolstra
72428e38d9 Generate separate manpages for each nix subcommand 2020-12-02 23:23:23 +01:00
Fabian Möller
5b0790355f
Fix macOS sandbox build 
Since c4c3c15c19 (#4251) building Nix for
macOS with sandboxing fails:
```
getting status of /nix/var/nix/profiles/per-user/root/channels/nixpkgs: Operation not permitted
```

This happens, because `EvalSettings::getDefaultNixPath` tries to access
paths outside the sandbox. Since the state-dir is not required for
doc generation, it is set to the dummy folder. This needs to be done
for all nix invocations during doc generation, as
`EvalSettings::getDefaultNixPath` is called unconditionally.
 2020-11-23 17:40:17 +01:00
Eelco Dolstra
58dadf2954 Remove stray 'Title:' from the manual 
Closes #4096.
 2020-10-08 17:30:40 +02:00
Fabian Möller
4abd5554ad
Fix macOS sandbox build 2020-10-02 15:40:55 +02:00
Eelco Dolstra
0066ef6c59 Fix doc generation 2020-09-16 16:56:28 +02:00
Eelco Dolstra
39bc49318f jq -> nix 2020-09-16 14:58:06 +02:00
Eelco Dolstra
0f314f3c25
Generate builtins section of the manual 2020-08-24 14:49:30 +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
8a97b11374
Improve margins between sections 
The default CSS puts almost no space between sections, but a lot of
space between subsections. This flips that around.
 2020-08-19 12:31:18 +02:00
Eelco Dolstra
6f19c776db
Start generation of the nix.1 manpage 2020-08-17 19:33:18 +02:00
Eelco Dolstra
1d0a7b54fa
Enable syntax highlighting 2020-07-31 15:43:25 +02:00
Eelco Dolstra
1308c8404e
Remove DocBook manual 2020-07-24 15:48:40 +02:00
Eelco Dolstra
efff6cf163
Install all manpages 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
8e41c38867
Remove references to xmllint 2020-07-23 18:26:48 +02:00
Eelco Dolstra
e0ea3c82ca
Use mdbook 2020-07-23 18:26:48 +02:00
Eelco Dolstra
858ad7a4b3 Remove callout graphics 
Fixes #3396.
 2020-03-13 16:32:43 +01:00
Eelco Dolstra
9c7e90f414
style.css: Remove 
This file is licensed under the GPL. Originally, Nix was also
GPL-licensed so that was fine. However, we later changed the license
to the LGPL but missed the fact that style.css has an incompatible
license.

Since the Nix manual at nixos.org uses its own styling, we can remove
this file.

Fixes #3392.
 2020-03-13 15:02:32 +01:00
Adrien Devresse
7ef053c632 Add a new option to disable documentation generation at configure time 2016-09-20 14:34:43 +00:00
Shea Levy
6e51af8023 Nuke nix-push. 
Rarely used, nix copy replaces it.
 2016-08-10 11:13:11 -04:00
Shea Levy
15c035c13f Remove nix-install-package. 
Refs #831
 2016-08-10 08:20:51 -04:00
aszlig
72fb2ccfa1
Don't hardcode docbook XSL namespace URL 
Docbook XSL got updated to version 1.79.1 in NixOS/nixpkgs@fb893a8 and
we're still referring to the hardcoded previous version.

So instead of just updating this to 1.79.1 we're going to use "current"
in the hope that this won't happen again.

I have tested this by building the manual under Nix(OS) but I haven't
tested this in a non-Nix environment, so I'm not sure whether this could
have implications.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
Cc: @edolstra
 2016-07-04 20:13:20 +02:00
Eelco Dolstra
58e423ce32 Remove PDF manual 
More spring cleaning.
 2016-04-14 12:50:01 +02:00
Eelco Dolstra
867967265b Remove manifest support 
Manifests have been superseded by binary caches for years. This also
gets rid of nix-pull, nix-generate-patches and bsdiff/bspatch.
 2016-04-11 16:20:15 +02:00
Eelco Dolstra
e90e7b5e0a Fix build 
http://hydra.nixos.org/build/17894500
 2014-12-14 01:29:35 +01:00
Eelco Dolstra
eb53f592b8 Fix image in PDF 
Closes #415.
 2014-12-14 01:23:06 +01:00
Eelco Dolstra
a144eb1415 Don't use ?= 2014-12-11 10:44:02 +01:00
darealshinji
40e1203abc allow custom docbook paths/URLs, use a working URL for docbook.rng 2014-12-11 10:43:46 +01:00
Eelco Dolstra
d4c8ee7059 Rely on XML catalogs to find the DocBook schemas and stylesheets 2014-11-25 15:54:26 +01:00
darealshinji
a5b5ebc45f add manpage for nix-generate-patches 2014-09-23 15:10:18 +02:00
Eelco Dolstra
f77d83c26b Style tweak 2014-09-16 15:37:38 +02:00
Eelco Dolstra
3c8522cc22 Fix parallel make of manpages 2014-09-16 15:29:55 +02:00
Eelco Dolstra
7a740c9288 Drop separate release notes 2014-09-16 14:52:44 +02:00
Eelco Dolstra
8259a392da Manual build fixes 2014-09-16 14:14:09 +02:00
Eelco Dolstra
e82951fe23 Manual: html -> xhtml 2014-07-03 12:36:58 +02:00
Eelco Dolstra
b0a09a6f32 Add docbook icons to the distribution 
Grmbl...
 2014-04-09 14:52:43 +02:00
Eelco Dolstra
d435e46daa Generate release notes again 2014-03-12 14:24:29 +01:00
Eelco Dolstra
6dca72006a Only run "git ls-files" when doing "make check" 2014-02-01 16:30:24 +01:00
Eelco Dolstra
844d83352c More "make dist" fixes 2014-02-01 15:18:48 +01:00
Eelco Dolstra
6ef32bddc1 Fix "make dist" 2014-02-01 14:38:12 +01:00
Eelco Dolstra
16e7d69209 Update Makefile variable names 2014-02-01 13:54:38 +01:00
Eelco Dolstra
ac8c2ef1aa Build/install manual 2014-02-01 11:30:21 +01:00