nixpkgs/nixos/doc/manual/Makefile

.PHONY: all
all: manual-combined.xml

.PHONY: debug
debug: generated manual-combined.xml

manual-combined.xml: generated *.xml **/*.xml
	rm -f ./manual-combined.xml
	nix-shell --pure -Q --packages xmloscopy \
		--run "xmloscopy --docbook5 ./manual.xml ./manual-combined.xml"

.PHONY: format
format:
	nix-shell --pure -Q --packages xmlformat \
		--run "find ../../ -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \
		xmlformat --config-file '../xmlformat.conf' -i {}"

.PHONY: fix-misc-xml
fix-misc-xml:
	find . -iname '*.xml' -type f \
		-exec ../varlistentry-fixer.rb {} ';'

.PHONY: clean
clean:
	rm -f manual-combined.xml generated

generated:
	nix-build ../../release.nix \
		--attr manualGeneratedSources.x86_64-linux \
		--out-link ./generated
nixos docs: makefile for formatting 2018-05-01 23:03:25 +01:00			`.PHONY: all`
nixos/doc/manual/Makefile: Do not format Formatting has been neglected. Running `make` would format dozens of files, which is a great way of scaring away newcomers and those with less git experience. It would also annoy the heck out of regular contributors. The purpose of formatting is to avoid a small annoyance, so it should not become a big annoyance that makes people give up on their work. 2021-03-22 20:15:11 +00:00			`all: manual-combined.xml`
nixos docs: makefile for formatting 2018-05-01 23:03:25 +01:00
			`.PHONY: debug`
			`debug: generated manual-combined.xml`

nixos/doc: Adds sub-folder to input files. 2018-10-04 03:33:03 +01:00			`manual-combined.xml: generated .xml /.xml`
nixos docs: fixup 2018-05-02 00:43:52 +01:00			`rm -f ./manual-combined.xml`
nixos manual Makefile: improve purity And be quiet when building/downloading the required tools. 2019-03-22 13:47:47 +00:00			`nix-shell --pure -Q --packages xmloscopy \`
nixos docs: makefile for formatting 2018-05-01 23:03:25 +01:00			`--run "xmloscopy --docbook5 ./manual.xml ./manual-combined.xml"`

			`.PHONY: format`
			`format:`
nixos manual Makefile: improve purity And be quiet when building/downloading the required tools. 2019-03-22 13:47:47 +00:00			`nix-shell --pure -Q --packages xmlformat \`
			`--run "find ../../ -iname '*.xml' -type f -print0 \| xargs -0 -I{} -n1 \`
			`xmlformat --config-file '../xmlformat.conf' -i {}"`
nixos docs: makefile for formatting 2018-05-01 23:03:25 +01:00
doc: Adds xml fixing script. (see previous and next commits) This script is used to automatically fix issues within xml documentation files. The script is for now intended to be used ad-hoc, and the commits to be examined. A future discussion will define whether: * This commit and scripts are kept. * The script is extended for common use. The biggest issue right now with the script is that it could in theory destroy a valid space-less varlistentry. The script could, in practical use, be changed and extended to normalize some parts of the XML files, mainly: * A common quoting style for attributes * Fix-up some weird formatting automatically that xmlformat doesn't catch 2018-06-01 01:26:27 +01:00			`.PHONY: fix-misc-xml`
			`fix-misc-xml:`
			`find . -iname '*.xml' -type f \`
			`-exec ../varlistentry-fixer.rb {} ';'`

nixos docs: makefile for formatting 2018-05-01 23:03:25 +01:00			`.PHONY: clean`
			`clean:`
			`rm -f manual-combined.xml generated`
nixos docs: Add a makefile for hacking on the nixos docs 2018-04-28 09:00:55 +01:00
nixos/doc/manual: Fix Makefile We had `./options-to-docbook.xsl` as a dependency for `generated` target but it was moved to a package in https://github.com/NixOS/nixpkgs/pull/66328. 2019-09-06 11:02:25 +01:00			`generated:`
nixos docs: Add a makefile for hacking on the nixos docs 2018-04-28 09:00:55 +01:00			`nix-build ../../release.nix \`
			`--attr manualGeneratedSources.x86_64-linux \`
			`--out-link ./generated`