Opened 7 years ago

Last modified 3 years ago

#2448 assigned task

configure.ac missing checks for --enable-generate-docs

Reported by: jelte Owned by: UnAssigned
Priority: low Milestone: Outstanding Tasks
Component: build system Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 4 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description (last modified by fdupont)

This is really mostly only relevant for devs updating documentation, but the configure checks done when doing --enable-generate-docs have some room for improvement:

on debian, if you do --enable-generate-docs, but don't have the 'xmlto' package installed, you get a rather cryptic error (I had only installed docbook and xsltproc initially):

checking for xsltproc... /usr/bin/xsltproc
checking if /usr/bin/xsltproc works... I/O error : Attempt to load network entity http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
warning: failed to load external entity "http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
cannot parse http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
configure: error: "Error with /usr/bin/xsltproc using release/xsl/current/manpages/docbook.xsl"

Also, elinks is needed in the build process

we probably want a few checks for both of these in configure.ac :)

Subtickets

Change History (10)

comment:1 Changed 7 years ago by jreed

Also see #1826 for some related discussion. (Maybe elinks is the wrong tool.)

comment:2 Changed 7 years ago by shane

  • Milestone New Tasks deleted

comment:3 Changed 7 years ago by naokikambe

That error seems to be caused because of no installed stylesheets for docbook, I think. It passed after I installed the docbook-style-xsl package on my fedora. The error message should be updated to install it?

BTW quick patches for checking elinks:

  • configure.ac

    diff --git a/configure.ac b/configure.ac
    index 3f7a269..5daf368 100644
    a b if test "x$enable_generate_docs" != xno ; then 
    11031103    fi
    11041104    AC_MSG_RESULT(yes)
    11051105  fi
     1106  # Check for elinks
     1107  AC_PATH_PROG([ELINKS], [elinks])
     1108  if test -z "$ELINKS"; then
     1109    AC_MSG_ERROR("elinks not found; it is required for --enable-generate-docs")
     1110  fi
    11061111fi
    11071112
    11081113
  • doc/guide/Makefile.am

    diff --git a/doc/guide/Makefile.am b/doc/guide/Makefile.am
    index 1d63c04..6f2b7e2 100644
    a b bind10-guide.html: bind10-guide.xml 
    2121               http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl \
    2222               $(srcdir)/bind10-guide.xml
    2323
    24 HTML2TXT = elinks -dump -no-numbering -no-references
     24HTML2TXT = @ELINKS@ -dump -no-numbering -no-references
    2525
    2626bind10-guide.txt: bind10-guide.html
    2727       $(HTML2TXT) bind10-guide.html > $@

This issue is rather related to #2527 but it's already closed.

comment:4 Changed 5 years ago by tomek

  • Milestone set to Remaining BIND10 tickets

comment:5 Changed 4 years ago by tomek

  • Milestone changed from Remaining BIND10 tickets to Kea1.2

comment:6 Changed 3 years ago by tomek

  • Priority changed from medium to low

Those tickets are not in scope for 1.2, but I decided to keep them as low.

comment:7 Changed 3 years ago by fdupont

  • Description modified (diff)
  • Owner changed from UnAssigned to fdupont
  • Status changed from new to accepted

comment:8 Changed 3 years ago by fdupont

  • Owner changed from fdupont to UnAssigned
  • Status changed from accepted to assigned

elinks check is already included. For missing docbook.xsl and co there is no standard name for the package providing it so I can't see how to really improve this. Giving up...

comment:9 Changed 3 years ago by tomek

  • Milestone changed from Kea1.2 to Kea1.2-final

Code freeze for 1.2-beta. Moving all remaining open tickets to 1.2-final.

comment:10 Changed 3 years ago by tomek

  • Milestone changed from Kea1.2-final to Outstanding Tasks

As discussed on 2017-04-13 call, moving to outstanding.

Note: See TracTickets for help on using tickets.