docs: move user and interface .tex documents under reference.

Taking over the top level "user" entry with a relatively obsolete document is a
bit of an annoyance but these docs are not so out of date that they should be
deleted. Move them out of the top-level instead.

(the original motivation here was to allow for user/xl-domain-cfg.markdown but
we have since decided to go with man/xl.cfg.pod.5 instead so perhaps this is a
waste of time)

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Committed-by: Ian Jackson <ian.jackson.citrix.com>
Acked-by: Ian Jackson <ian.jackson.citrix.com>

diff --git a/docs/INDEX b/docs/INDEX
index 7624429e2b1152a513bcc05c5914edbe5655e671..f3b87a20b160fef1ee3036fbffcc154e58f9f7ad 100644 (file)
--- a/docs/INDEX
+++ b/docs/INDEX
@@ -1,5 +1,5 @@
 misc/hvm-emulated-unplug       Xen HVM emulated device unplug protocol
 
 # These are not all that useful anymore, hide them from the index
-interface/index                        NO-INDEX
-user/index                     NO-INDEX
+reference/interface/index      NO-INDEX
+reference/user/index           NO-INDEX

diff --git a/docs/Makefile b/docs/Makefile
index 2dde146b2ca1bde5c6aefd084b30c9bd487c42d5..da9b9859e066a16b6db91f15ea6beb10dbc4bea1 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -14,7 +14,7 @@ DOC_TEX               := src/user.tex src/interface.tex
 DOC_MARKDOWN   := $(wildcard misc/*.markdown)
 DOC_PS         := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
 DOC_PDF                := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
-DOC_HTML       := $(patsubst src/%.tex,html/%/index.html,$(DOC_TEX)) \
+DOC_HTML       := $(patsubst src/%.tex,html/reference/%/index.html,$(DOC_TEX)) \
                   $(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \
                   $(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \
                   $(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC))
@@ -119,14 +119,14 @@ ps/%.ps: %.dvi
 %.eps: %.fig
        $(FIG2DEV) -L eps $< $@
 
-html/%/index.html: src/%.tex
+html/reference/%/index.html: src/%.tex
        @$(INSTALL_DIR) $(@D)
        @set -e ; if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \
-        echo "Running latex2html to generate $*/index.html ... "; \
+        echo "Running latex2html to generate reference/$*/index.html ... "; \
        $(LATEX2HTML) -split 0 -show_section_numbers -toc_depth 3 -nonavigation \
        -numbered_footnotes -local_icons -noinfo -math -dir $(@D) \
        $< 1>/dev/null 2>/dev/null ; else \
-       echo "latex2html not installed; skipping $*."; fi
+       echo "latex2html not installed; skipping reference/$*."; fi
 
 html/index.html: $(DOC_HTML) ./gen-html-index INDEX
        perl -w -- ./gen-html-index -i INDEX html $(DOC_HTML)