forked from lix-project/lix
meson: fix warm nix3 CLI manual generation
`nix eval --write-to` refuses to write to a directory that exists at
all, so now we generate in a temporary directory, and copy the generated
tree to the build directory. This is equivalent to what the Make
buildsystem did, actually, but hopefully more robust.
Change-Id: Ic3eb6d26e3cc249a1c042fd3ced22d637ac66a69
This commit is contained in:
parent
b47c159aec
commit
d18f187e0e
47
doc/manual/generate-manpage.py
Executable file
47
doc/manual/generate-manpage.py
Executable file
|
@ -0,0 +1,47 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
import os.path
|
||||
import shlex
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
|
||||
name = 'generate-manpage.py'
|
||||
|
||||
def log(*args, **kwargs):
|
||||
kwargs['file'] = sys.stderr
|
||||
return print(f'{name}:', *args, **kwargs)
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(name)
|
||||
parser.add_argument('--nix', help='Full path to the nix binary to use')
|
||||
parser.add_argument('-o', '--output', help='Output directory')
|
||||
parser.add_argument('--generator', help='Path to generate-manpage.nix')
|
||||
parser.add_argument('--cli-json', help='Path to the nix.json output from Nix')
|
||||
args = parser.parse_args()
|
||||
|
||||
with tempfile.TemporaryDirectory() as tempdir:
|
||||
|
||||
temp_out = os.path.join(tempdir, 'new-cli')
|
||||
|
||||
nix_args = [
|
||||
args.nix,
|
||||
'eval',
|
||||
'-I', 'nix/corepkgs=corepkgs',
|
||||
'--store', 'dummy://',
|
||||
'--impure',
|
||||
'--raw',
|
||||
'--write-to', temp_out,
|
||||
'--expr',
|
||||
f'import {args.generator} true (builtins.readFile {args.cli_json})',
|
||||
]
|
||||
|
||||
log('generating nix3 man pages with', shlex.join(nix_args))
|
||||
|
||||
subprocess.check_call(nix_args)
|
||||
|
||||
shutil.copytree(temp_out, args.output, dirs_exist_ok=True)
|
||||
|
||||
sys.exit(main())
|
|
@ -132,15 +132,26 @@ nix3_cli_json = custom_target(
|
|||
capture : true,
|
||||
output : 'nix.json',
|
||||
)
|
||||
# `nix eval --write-to` is rather picky, and refuses to write to a directory that exists at all.
|
||||
# This is fine for clean builds because it creates the directory and then is never run again,
|
||||
# but during development if nix.json changes, then using `nix eval --write-to` will error,
|
||||
# since that part of the build directory already exists.
|
||||
# Thus, another Python script. It runs the relevant `nix eval --write-to` command in a temporary
|
||||
# directory, and then copies that tree to our build output directory.
|
||||
nix3_cli_files = custom_target(
|
||||
command : nix_eval_for_docs + [
|
||||
'--write-to', '@OUTPUT@',
|
||||
'--expr',
|
||||
'import @INPUT1@ true (builtins.readFile @INPUT0@)',
|
||||
command : [
|
||||
python,
|
||||
'@INPUT0@',
|
||||
'--nix=@INPUT1@',
|
||||
'--generator=@INPUT2@',
|
||||
'--cli-json=@INPUT3@',
|
||||
'--output=@OUTPUT@',
|
||||
],
|
||||
input : [
|
||||
nix3_cli_json,
|
||||
'generate-manpage.nix',
|
||||
'generate-manpage.py', # INPUT0
|
||||
nix, # INPUT1
|
||||
'generate-manpage.nix', # INPUT2
|
||||
nix3_cli_json, # INPUT3
|
||||
'utils.nix',
|
||||
],
|
||||
output : 'new-cli',
|
||||
|
|
Loading…
Reference in a new issue