Skip to content

Commit

Permalink
Add 'make debug' to call xmloscopy
Browse files Browse the repository at this point in the history
  • Loading branch information
grahamc committed Mar 26, 2018
1 parent fce1fb7 commit 67f9d24
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
3 changes: 3 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ MD_TARGETS=$(addsuffix .xml, $(basename $(wildcard ./*.md ./**/*.md)))
.PHONY: all
all: validate out/html/index.html out/epub/manual.epub

.PHONY: debug
debug:
nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
.PHONY: clean
clean:
rm -f ${MD_TARGETS} .version manual-full.xml
Expand Down
5 changes: 2 additions & 3 deletions doc/contributing.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ subdirectory of the Nixpkgs repository.</para>
[nix-shell]$ make
</screen>

<para>If you experience problems, run <command>xmloscopy --docbook5
./manual.xml ./manual-full.xml</command> inside the nix-shell to help
understand the docbook errors.</para>
<para>If you experience problems, run <command>make debug</command>
to help understand the docbook errors.</para>

<para>After making modifications to the manual, it's important to
build it before committing. You can do that as follows:
Expand Down

0 comments on commit 67f9d24

Please sign in to comment.