summary refs log tree commit diff
path: root/doc/Makefile
diff options
context:
space:
mode:
authorSamuel Dionne-Riel <samuel@dionne-riel.com>2018-05-31 20:26:27 -0400
committerSamuel Dionne-Riel <samuel@dionne-riel.com>2018-05-31 21:02:15 -0400
commitbc0421c4cf18c431ece8d6a19f723159316f55ff (patch)
tree6c81b79df1a0ad4c24519a508f15e81fea2d5126 /doc/Makefile
parentaa59151c21c353923b3f003662f17f2210c63c57 (diff)
downloadnixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar.gz
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar.bz2
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar.lz
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar.xz
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.tar.zst
nixpkgs-bc0421c4cf18c431ece8d6a19f723159316f55ff.zip
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
Diffstat (limited to 'doc/Makefile')
-rw-r--r--doc/Makefile5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 8a4612e95f1..ba77be6678c 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -12,6 +12,11 @@ format:
 	find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \
 		xmlformat --config-file "$$XMLFORMAT_CONFIG" -i {}
 
+.PHONY: fix-misc-xml
+fix-misc-xml:
+	find . -iname '*.xml' -type f \
+		-exec ../nixos/doc/varlistentry-fixer.rb {} ';'
+
 .PHONY: clean
 clean:
 	rm -f ${MD_TARGETS} .version manual-full.xml