eisfunke/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity
lix/doc/manual/local.mk

79 lines
2.9 KiB
Makefile
Raw Normal View History

Add a new option to disable documentation generation at configure time
2016-09-20 14:31:23 +00:00
ifeq ($(doc_generate),yes)
Use mdbook
2020-07-22 18:27:23 +00:00
MANUAL_SRCS := $(call rwildcard, $(d)/src, *.md)
Build/install manual
2014-02-01 10:30:21 +00:00
# Generate man pages.
man-pages := $(foreach n, \
Start generation of the nix.1 manpage
2020-08-17 17:33:18 +00:00
nix-env.1 nix-build.1 nix-shell.1 nix-store.1 nix-instantiate.1 nix.1 \
Install all manpages
2020-07-23 11:09:30 +00:00
nix-collect-garbage.1 \
nix-prefetch-url.1 nix-channel.1 \
nix-hash.1 nix-copy-closure.1 \
nix.conf.5 nix-daemon.8, \
Build/install manual
2014-02-01 10:30:21 +00:00
$(d)/$(n))
Fix parallel make of manpages
2014-09-16 13:29:55 +00:00
Update Makefile variable names
2014-02-01 11:23:14 +00:00
clean-files += $(d)/*.1 $(d)/*.5 $(d)/*.8
Build/install manual
2014-02-01 10:30:21 +00:00
Only run "git ls-files" when doing "make check"
2014-02-01 15:30:24 +00:00
dist-files += $(man-pages)
More "make dist" fixes
2014-02-01 14:18:48 +00:00
Fix macOS sandbox build Since c4c3c15c19bc448a4797e5d9577539cc14890618 (#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 16:40:17 +00:00
# Provide a dummy environment for nix, so that it will not access files outside the macOS sandbox.
dummy-env = env -i \
HOME=/dummy \
NIX_CONF_DIR=/dummy \
NIX_SSL_CERT_FILE=/dummy/no-ca-bundle.crt \
NIX_STATE_DIR=/dummy
nix-eval = $(dummy-env) $(bindir)/nix eval --experimental-features nix-command -I nix/corepkgs=corepkgs --store dummy:// --impure --raw --expr
Fix doc generation
2020-09-16 14:56:28 +00:00
Install all manpages
2020-07-23 11:09:30 +00:00
$(d)/%.1: $(d)/src/command-ref/%.md
Remove stray 'Title:' from the manual Closes #4096.
2020-10-08 15:30:40 +00:00
@printf "Title: %s\n\n" "$$(basename $@ .1)" > $^.tmp
@cat $^ >> $^.tmp
$(trace-gen) lowdown -sT man $^.tmp -o $@
@rm $^.tmp
Install all manpages
2020-07-23 11:09:30 +00:00
$(d)/%.8: $(d)/src/command-ref/%.md
Remove stray 'Title:' from the manual Closes #4096.
2020-10-08 15:30:40 +00:00
@printf "Title: %s\n\n" "$$(basename $@ .8)" > $^.tmp
@cat $^ >> $^.tmp
$(trace-gen) lowdown -sT man $^.tmp -o $@
@rm $^.tmp
Build/install manual
2014-02-01 10:30:21 +00:00
Convert nix.conf manpage
2020-07-23 08:56:15 +00:00
$(d)/nix.conf.5: $(d)/src/command-ref/conf-file.md
Remove stray 'Title:' from the manual Closes #4096.
2020-10-08 15:30:40 +00:00
@printf "Title: %s\n\n" "$$(basename $@ .5)" > $^.tmp
@cat $^ >> $^.tmp
$(trace-gen) lowdown -sT man $^.tmp -o $@
@rm $^.tmp
Convert nix.conf manpage
2020-07-23 08:56:15 +00:00
jq -> nix
2020-09-16 12:55:24 +00:00
$(d)/src/command-ref/nix.md: $(d)/nix.json $(d)/generate-manpage.nix $(bindir)/nix
Fix doc generation
2020-09-16 14:56:28 +00:00
$(trace-gen) $(nix-eval) 'import doc/manual/generate-manpage.nix (builtins.fromJSON (builtins.readFile $<))' > $@.tmp
@mv $@.tmp $@
Start generation of the nix.1 manpage
2020-08-17 17:33:18 +00:00
jq -> nix
2020-09-16 12:55:24 +00:00
$(d)/src/command-ref/conf-file.md: $(d)/conf-file.json $(d)/generate-options.nix $(d)/src/command-ref/conf-file-prefix.md $(bindir)/nix
Fix doc generation
2020-09-16 14:56:28 +00:00
@cat doc/manual/src/command-ref/conf-file-prefix.md > $@.tmp
$(trace-gen) $(nix-eval) 'import doc/manual/generate-options.nix (builtins.fromJSON (builtins.readFile $<))' >> $@.tmp
@mv $@.tmp $@
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 16:28:04 +00:00
Start generation of the nix.1 manpage
2020-08-17 17:33:18 +00:00
$(d)/nix.json: $(bindir)/nix
Fix macOS sandbox build Since c4c3c15c19bc448a4797e5d9577539cc14890618 (#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 16:40:17 +00:00
$(trace-gen) $(dummy-env) $(bindir)/nix __dump-args > $@.tmp
Fix doc generation
2020-09-16 14:56:28 +00:00
@mv $@.tmp $@
Start generation of the nix.1 manpage
2020-08-17 17:33:18 +00:00
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 16:28:04 +00:00
$(d)/conf-file.json: $(bindir)/nix
Fix macOS sandbox build Since c4c3c15c19bc448a4797e5d9577539cc14890618 (#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 16:40:17 +00:00
$(trace-gen) $(dummy-env) $(bindir)/nix show-config --json --experimental-features nix-command > $@.tmp
Fix doc generation
2020-09-16 14:56:28 +00:00
@mv $@.tmp $@
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 16:28:04 +00:00
jq -> nix
2020-09-16 12:55:24 +00:00
$(d)/src/expressions/builtins.md: $(d)/builtins.json $(d)/generate-builtins.nix $(d)/src/expressions/builtins-prefix.md $(bindir)/nix
Fix doc generation
2020-09-16 14:56:28 +00:00
@cat doc/manual/src/expressions/builtins-prefix.md > $@.tmp
$(trace-gen) $(nix-eval) 'import doc/manual/generate-builtins.nix (builtins.fromJSON (builtins.readFile $<))' >> $@.tmp
@mv $@.tmp $@
Generate builtins section of the manual
2020-08-24 12:49:30 +00:00
$(d)/builtins.json: $(bindir)/nix
Fix macOS sandbox build Since c4c3c15c19bc448a4797e5d9577539cc14890618 (#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 16:40:17 +00:00
$(trace-gen) $(dummy-env) NIX_PATH=nix/corepkgs=corepkgs $(bindir)/nix __dump-builtins > $@.tmp
Fix doc generation
2020-09-16 14:56:28 +00:00
mv $@.tmp $@
Generate builtins section of the manual
2020-08-24 12:49:30 +00:00
Use mdbook
2020-07-22 18:27:23 +00:00
# Generate the HTML manual.
install: $(docdir)/manual/index.html
Build/install manual
2014-02-01 10:30:21 +00:00
Generate builtins section of the manual
2020-08-24 12:49:30 +00:00
$(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/custom.css $(d)/src/command-ref/nix.md $(d)/src/command-ref/conf-file.md $(d)/src/expressions/builtins.md
Use mdbook
2020-07-22 18:27:23 +00:00
$(trace-gen) mdbook build doc/manual -d $(docdir)/manual
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
@cp doc/manual/highlight.pack.js $(docdir)/manual/highlight.js
Add a new option to disable documentation generation at configure time
2016-09-20 14:31:23 +00:00
endif
Copy permalink