Skip to contentSkip to conversation

docs: make 'gmake dist-docs' work

PATCH Superseded Egger Christoph 2 participants 6 messages Apr 22, 2013 – May 10, 2013

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: make 'gmake dist-docs' work

doc: Makefile fixes

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

docs/Makefile +6 -8
index 5f319a1..d247dea 100644
@@ -1,5 +1,3 @@
-#!/usr/bin/make -f
-
 XEN_ROOT=$(CURDIR)/..
 include $(XEN_ROOT)/Config.mk
 -include $(XEN_ROOT)/config/Docs.mk
@@ -75,7 +73,7 @@ clean:
 
 .PHONY: distclean
 distclean: clean
-	rm -rf ../config/Docs.mk config.log config.status config.cache \
+	rm -rf $(XEN_ROOT)/config/Docs.mk config.log config.status config.cache \
 		autom4te.cache
 
 .PHONY: install
@@ -88,8 +86,8 @@ install: all
 	cp -R man5 $(DESTDIR)$(MANDIR)
 	[ ! -d html ] || cp -R html $(DESTDIR)$(DOCDIR)
 
-html/index.html: $(DOC_HTML) ./gen-html-index INDEX
-	perl -w -- ./gen-html-index -i INDEX html $(DOC_HTML)
+html/index.html: $(DOC_HTML) $(CURDIR)/gen-html-index INDEX
+	$(PERL) -w -- $(CURDIR)/gen-html-index -i INDEX html $(DOC_HTML)
 
 html/%.html: %.markdown
 	$(INSTALL_DIR) $(@D)
@@ -123,13 +121,13 @@ else
 	@echo "pod2html not installed; skipping $<."
 endif
 
-html/hypercall/index.html: ./xen-headers
+html/hypercall/index.html: $(CURDIR)/xen-headers
 	rm -rf $(@D)
 	$(INSTALL_DIR) $(@D)
-	./xen-headers -O $(@D) \
+	$(PERL) -w $(CURDIR)/xen-headers -O $(@D) \
 		-T 'arch-x86_64 - Xen public headers' \
 		-X arch-ia64 -X arch-x86_32 -X xen-x86_32 -X arch-arm \
-		../xen include/public include/xen/errno.h
+		$(XEN_ROOT)/xen include/public include/xen/errno.h
 
 -include html/hypercall/.deps
 

commit eab28e737b01fdbe929a66a6f1c55a3b89bc2fb7

Author: Christoph Egger <[email protected]>
Date:   Thu Apr 4 13:30:30 2013 +0000

doc: Makefile fixes

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

docs/Makefile +6 -8
index 5f319a1..d247dea 100644
@@ -1,5 +1,3 @@
-#!/usr/bin/make -f
-
 XEN_ROOT=$(CURDIR)/..
 include $(XEN_ROOT)/Config.mk
 -include $(XEN_ROOT)/config/Docs.mk
@@ -75,7 +73,7 @@ clean:
 
 .PHONY: distclean
 distclean: clean
-	rm -rf ../config/Docs.mk config.log config.status config.cache \
+	rm -rf $(XEN_ROOT)/config/Docs.mk config.log config.status config.cache \
 		autom4te.cache
 
 .PHONY: install
@@ -88,8 +86,8 @@ install: all
 	cp -R man5 $(DESTDIR)$(MANDIR)
 	[ ! -d html ] || cp -R html $(DESTDIR)$(DOCDIR)
 
-html/index.html: $(DOC_HTML) ./gen-html-index INDEX
-	perl -w -- ./gen-html-index -i INDEX html $(DOC_HTML)
+html/index.html: $(DOC_HTML) $(CURDIR)/gen-html-index INDEX
+	$(PERL) -w -- $(CURDIR)/gen-html-index -i INDEX html $(DOC_HTML)
 
 html/%.html: %.markdown
 	$(INSTALL_DIR) $(@D)
@@ -123,13 +121,13 @@ else
 	@echo "pod2html not installed; skipping $<."
 endif
 
-html/hypercall/index.html: ./xen-headers
+html/hypercall/index.html: $(CURDIR)/xen-headers
 	rm -rf $(@D)
 	$(INSTALL_DIR) $(@D)
-	./xen-headers -O $(@D) \
+	$(PERL) -w $(CURDIR)/xen-headers -O $(@D) \
 		-T 'arch-x86_64 - Xen public headers' \
 		-X arch-ia64 -X arch-x86_32 -X xen-x86_32 -X arch-arm \
-		../xen include/public include/xen/errno.h
+		$(XEN_ROOT)/xen include/public include/xen/errno.h
 
 -include html/hypercall/.deps
 

_______________________________________________
Xen-devel mailing list
[email protected]
http://lists.xen.org/xen-devel

#1 lore raw
Quoted 4 lines · Egger Christoph

doc: Makefile fixes

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

Did you test this? Because it causes the hypercall docs to not be built or installed for me.

        w /local/scratch/ianc/devel/committer.git/docs/xen-headers -O html/hypercall \
        		-T 'arch-x86_64 - Xen public headers' \
        		-X arch-ia64 -X arch-x86_32 -X xen-x86_32 -X arch-arm \
        		/local/scratch/ianc/devel/committer.git/docs/../xen include/public include/xen/errno.h
        w: invalid option -- 'O'
        
        Usage:
         w [options]
        
        Options:
         -h, --no-header     do not print header
         -u, --no-current    ignore current process username
         -s, --short         short format
         -f, --from          show remote hostname field
         -o, --old-style     old style output
        
             --help     display this help and exit
         -V, --version  output version information and exit
        
        For more details see w(1).
        make[1]: [html/hypercall/index.html] Error 1 (ignored)

$(PERL) is defined in config/Tools.mk but docs/Makefile by design only includes config/Docs.mk. I think you need to check for perl in docs/configure.ac as well and propagate the result into config/Docs.mk
AC_ARG_VAR([PERL], [Path to Perl parser]) AX_PATH_PROG_OR_FAIL([PERL], [perl])

The reason for checking twice is to support people who only want to build the docs and not the tools and therefore only run configure in the subdirectory.

Ian.

#2 lore raw
Quoted 7 lines · Ian Campbell
Quoted 4 lines · Egger Christoph

doc: Makefile fixes

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

Did you test this?

Yes.

[...]

Quoted 5 lines

$(PERL) is defined in config/Tools.mk but docs/Makefile by design only includes config/Docs.mk. I think you need to check for perl in docs/configure.ac as well and propagate the result into config/Docs.mk
AC_ARG_VAR([PERL], [Path to Perl parser]) AX_PATH_PROG_OR_FAIL([PERL], [perl])

docs/Makefile also includes Config.mk which in turn includes config/Tools.mk.

Quoted 1 line

From there $(PERL) is defined and makes this patch work.

Christoph

Quoted 7 lines

The reason for checking twice is to support people who only want to build the docs and not the tools and therefore only run configure in the subdirectory.

Ian.

#3 lore raw
Quoted 10 lines · Christoph Egger
Quoted 7 lines · Ian Campbell
Quoted 4 lines · Egger Christoph

doc: Makefile fixes

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

Did you test this?

Yes.

Against unstable?

Quoted 10 lines

[...]

Quoted 5 lines

$(PERL) is defined in config/Tools.mk but docs/Makefile by design only includes config/Docs.mk. I think you need to check for perl in docs/configure.ac as well and propagate the result into config/Docs.mk
AC_ARG_VAR([PERL], [Path to Perl parser]) AX_PATH_PROG_OR_FAIL([PERL], [perl])

docs/Makefile also includes Config.mk which in turn includes config/Tools.mk.

Not here it doesn't:

        $ git show --oneline
        0a97f68 install qemu into the location specified via configure --prefix.
        ...
        $ grep Tools.mk Config.mk 
        $
        $ grep include Config.mk 
        -include $(XEN_ROOT)/.config
        include $(XEN_ROOT)/config/$(XEN_OS).mk
        include $(XEN_ROOT)/config/$(XEN_TARGET_ARCH).mk
        EXTRA_INCLUDES += $(EXTRA_PREFIX)/include
        $
        $ rgrep -l Tools.mk *
        tools/config.status
        tools/Makefile
        tools/Rules.mk
        tools/configure.ac
        tools/config.log
        tools/configure

Perhaps you have some other local patches?

Ian.

#4 lore raw
Quoted 5 lines · Ian Campbell
Quoted 4 lines · Christoph Egger
Quoted 3 lines · Ian Campbell
Quoted 2 lines · Egger Christoph

doc: Makefile fixes

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines
Quoted 2 lines

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

Did you test this?

Yes.

Against unstable?

yes.

Quoted 32 lines
Quoted 11 lines

[...]

Quoted 5 lines

$(PERL) is defined in config/Tools.mk but docs/Makefile by design only includes config/Docs.mk. I think you need to check for perl in docs/configure.ac as well and propagate the result into config/Docs.mk
AC_ARG_VAR([PERL], [Path to Perl parser]) AX_PATH_PROG_OR_FAIL([PERL], [perl])

docs/Makefile also includes Config.mk which in turn includes config/Tools.mk.

Not here it doesn't:

        $ git show --oneline
        0a97f68 install qemu into the location specified via configure --prefix.
        ...
        $ grep Tools.mk Config.mk 
        $
        $ grep include Config.mk 
        -include $(XEN_ROOT)/.config
        include $(XEN_ROOT)/config/$(XEN_OS).mk
        include $(XEN_ROOT)/config/$(XEN_TARGET_ARCH).mk
        EXTRA_INCLUDES += $(EXTRA_PREFIX)/include
        $
        $ rgrep -l Tools.mk *
        tools/config.status
        tools/Makefile
        tools/Rules.mk
        tools/configure.ac
        tools/config.log
        tools/configure
Quoted 1 line

Perhaps you have some other local patches?

Yes. Just submitted with subject
'[Xen-devel] [PATCH] Make sure to use tools as found by configure'.

Christoph

#5 lore raw
Quoted 49 lines · Christoph Egger
Quoted 5 lines · Ian Campbell
Quoted 4 lines · Christoph Egger
Quoted 3 lines · Ian Campbell
Quoted 2 lines · Egger Christoph

doc: Makefile fixes

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines
Quoted 2 lines

- use correct pathes (make gmake dist-docs from toplevel directory work)
- use tools as found by configure (perl)

Did you test this?

Yes.

Against unstable?

yes.

Quoted 32 lines
Quoted 11 lines

[...]

Quoted 5 lines

$(PERL) is defined in config/Tools.mk but docs/Makefile by design only includes config/Docs.mk. I think you need to check for perl in docs/configure.ac as well and propagate the result into config/Docs.mk
AC_ARG_VAR([PERL], [Path to Perl parser]) AX_PATH_PROG_OR_FAIL([PERL], [perl])

docs/Makefile also includes Config.mk which in turn includes config/Tools.mk.

Not here it doesn't:

        $ git show --oneline
        0a97f68 install qemu into the location specified via configure --prefix.
        ...
        $ grep Tools.mk Config.mk 
        $
        $ grep include Config.mk 
        -include $(XEN_ROOT)/.config
        include $(XEN_ROOT)/config/$(XEN_OS).mk
        include $(XEN_ROOT)/config/$(XEN_TARGET_ARCH).mk
        EXTRA_INCLUDES += $(EXTRA_PREFIX)/include
        $
        $ rgrep -l Tools.mk *
        tools/config.status
        tools/Makefile
        tools/Rules.mk
        tools/configure.ac
        tools/config.log
        tools/configure
Quoted 4 lines
Quoted 1 line

Perhaps you have some other local patches?

Yes. Just submitted with subject
'[Xen-devel] [PATCH] Make sure to use tools as found by configure'.

I send a new version.

Christoph