bbjubjub2494/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

doc: remove the -- unescaping hack

Browse source 
lowdown has an option to disable this behavior. use it.

Change-Id: I06d4201b7f528021ddb8e94ac6baff385402e080
This commit is contained in:
eldritch horrors 2024-03-30 17:38:36 +01:00
parent ed2bb919e7
commit d2aca15f31
3 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/manual/local.mk
View file

@ -41,11 +41,11 @@ nix-eval = $(dummy-env) $(doc_nix) eval --experimental-features nix-command -I n
$(d)/nix-env-%.1: $(d)/src/command-ref/nix-env/%.md $(d)/nix-env-%.1: $(d)/src/command-ref/nix-env/%.md
$(trace-gen) doc/manual/render-manpage.sh \ $(trace-gen) doc/manual/render-manpage.sh \
--unescape-dashes "$(subst nix-env-,nix-env --,$$(basename "$@" .1))" 1 $^ $^.tmp $@ --out-no-smarty "$(subst nix-env-,nix-env --,$$(basename "$@" .1))" 1 $^ $^.tmp $@
$(d)/nix-store-%.1: $(d)/src/command-ref/nix-store/%.md $(d)/nix-store-%.1: $(d)/src/command-ref/nix-store/%.md
$(trace-gen) doc/manual/render-manpage.sh \ $(trace-gen) doc/manual/render-manpage.sh \
--unescape-dashes "$(subst nix-store-,nix-store --,$$(basename "$@" .1))" 1 $^ $^.tmp $@ --out-no-smarty "$(subst nix-store-,nix-store --,$$(basename "$@" .1))" 1 $^ $^.tmp $@
$(d)/%.1: $(d)/src/command-ref/%.md $(d)/%.1: $(d)/src/command-ref/%.md

2
doc/manual/meson.build
View file

@ -112,7 +112,7 @@ foreach command : nix_nested_manpages
custom_target( custom_target(
command : [ command : [
'./render-manpage.sh', './render-manpage.sh',
'--unescape-dashes', '--out-no-smarty',
command[0] + ' --' + page, command[0] + ' --' + page,
'1', '1',
'@INPUT@', '@INPUT@',

13
doc/manual/render-manpage.sh
View file

@ -2,10 +2,10 @@
set -euo pipefail set -euo pipefail
unescape_dashes= lowdown_args=
if [ "$1" = --unescape-dashes ]; then if [ "$1" = --out-no-smarty ]; then
unescape_dashes=yes lowdown_args=--out-no-smarty
shift shift
fi fi
@ -18,10 +18,5 @@ outfile="$5"
printf "Title: %s\n\n" "$title" > "$tmpfile" printf "Title: %s\n\n" "$title" > "$tmpfile"
cat "$infile" >> "$tmpfile" cat "$infile" >> "$tmpfile"
"$(dirname "$0")"/process-includes.sh "$infile" "$tmpfile" "$(dirname "$0")"/process-includes.sh "$infile" "$tmpfile"
lowdown -sT man --nroff-nolinks -M section="$section" "$tmpfile" -o "$outfile" lowdown -sT man --nroff-nolinks $lowdown_args -M section="$section" "$tmpfile" -o "$outfile"
if [ -n "$unescape_dashes" ]; then
# fix up `lowdown`'s automatic escaping of `--`
# https://github.com/kristapsdz/lowdown/blob/edca6ce6d5336efb147321a43c47a698de41bb7c/entity.c#L202
sed -i 's/\e\[u2013\]/--/' "$outfile"
fi
rm "$tmpfile" rm "$tmpfile"