diff options
| author | Eelco Dolstra <edolstra@gmail.com> | 2021-07-27 14:53:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-27 14:53:16 +0200 |
| commit | 706777a4a8b13771221f9b0ef3e984a50562e82b (patch) | |
| tree | 989ffd825cbfcc91c5c912a18b3aa8a92b601ac7 | |
| parent | c000cec27fcb16548606830410be265eb082f777 (diff) | |
| parent | 441be5d59aa1d3c223979e257ed9bae5d7e3b093 (diff) | |
Merge pull request #5055 from NixOS/fix-manpages-install
Fix the generation of nix3 manpages
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | doc/manual/local.mk | 21 |
2 files changed, 13 insertions, 11 deletions
diff --git a/.gitignore b/.gitignore index ef0298417..1affd733d 100644 --- a/.gitignore +++ b/.gitignore @@ -12,9 +12,10 @@ perl/Makefile.config /libtool # /doc/manual/ -/doc/manual/**/*.1 +/doc/manual/*.1 /doc/manual/*.5 /doc/manual/*.8 +/doc/manual/generated/* /doc/manual/nix.json /doc/manual/conf-file.json /doc/manual/builtins.json diff --git a/doc/manual/local.mk b/doc/manual/local.mk index 435301279..dd1d5f0fa 100644 --- a/doc/manual/local.mk +++ b/doc/manual/local.mk @@ -1,9 +1,5 @@ ifeq ($(doc_generate),yes) -ALL_MD_FILES := $(call rwildcard, $(d)/src, *.md) -GENERATED_MD_FILES := $(call rwildcard, $(d)/src/command-ref/new-cli, *.md) -MANUAL_SRCS := $(filter-out $(GENERATED_MD_FILES), $(ALL_MD_FILES)) - # Generate man pages. man-pages := $(foreach n, \ nix-env.1 nix-build.1 nix-shell.1 nix-store.1 nix-instantiate.1 \ @@ -77,21 +73,26 @@ $(d)/builtins.json: $(bindir)/nix install: $(docdir)/manual/index.html # Generate 'nix' manpages. -install: $(mandir)/man1/nix3-build.1 +install: $(mandir)/man1/nix3-manpages +man: doc/manual/generated/man1/nix3-manpages +all: doc/manual/generated/man1/nix3-manpages + +$(mandir)/man1/nix3-manpages: doc/manual/generated/man1/nix3-manpages + @mkdir -p $$(dirname $@) + $(trace-install) install -m 0644 $$(dirname $<)/* $$(dirname $@) -# Technically this rule generates all the `nix3-*` manpages, but since we don’t -# know their list statically and they are all generated at once anyways, we can -# just be dirty and only track one -$(mandir)/man1/nix3-build.1: $(d)/src/command-ref/new-cli +doc/manual/generated/man1/nix3-manpages: $(d)/src/command-ref/new-cli + @mkdir -p $$(dirname $@) $(trace-gen) for i in doc/manual/src/command-ref/new-cli/*.md; do \ name=$$(basename $$i .md); \ tmpFile=$$(mktemp); \ if [[ $$name = SUMMARY ]]; then continue; fi; \ printf "Title: %s\n\n" "$$name" > $$tmpFile; \ cat $$i >> $$tmpFile; \ - lowdown -sT man -M section=1 $$tmpFile -o $(mandir)/man1/$$name.1; \ + lowdown -sT man -M section=1 $$tmpFile -o $$(dirname $@)/$$name.1; \ rm $$tmpFile; \ done + touch $@ $(docdir)/manual/index.html: $(MANUAL_SRCS) $(d)/book.toml $(d)/custom.css $(d)/src/SUMMARY.md $(d)/src/command-ref/new-cli $(d)/src/command-ref/conf-file.md $(d)/src/expressions/builtins.md $(trace-gen) RUST_LOG=warn mdbook build doc/manual -d $(docdir)/manual |