Patchwork [0/8] support xmlto

login
register
mail settings
Submitter Hongxu Jia
Date July 8, 2014, 9:47 a.m.
Message ID <cover.1404812342.git.hongxu.jia@windriver.com>
Download mbox
Permalink /patch/75151/
State New
Headers show

Pull-request

git://git.pokylinux.org/poky-contrib hongxu/support-xmlto

Comments

Hongxu Jia - July 8, 2014, 9:47 a.m.
The xmlto was shipped from meta-oe, and fixed the defects that
'xmlto/xsltproc stylesheets cannot be found even when they are
installed in sysroot'

The xmlto required docbook-xml-dtd and docbook-xsl-stylesheets,
we refered debian's docbook-xml-dtd and ubuntu config.

We also enable xmlto for alsa-utils, xorg-proto-common.inc,
xorg-lib-common.inc, xserver-xorg.inc.

The test is easy, just build alsa-utils.

BTW: after this merged, I will clean up the duplicate one in meta-oe.

[YOCTO #2416]

//Hongxu

The following changes since commit a5531a2b8983318b99c119a87b78a92cf84160b8:

  bitbake: fetch2/svn: Add transportuser parameter (2014-07-04 09:28:36 +0100)

are available in the git repository at:

  git://git.pokylinux.org/poky-contrib hongxu/support-xmlto
  http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=hongxu/support-xmlto

Hongxu Jia (8):
  libxml2: enable Catalog support
  docbook-xml: add docbook-xsl-stylesheets 1.78.1
  docbook-xml: add docbook-xml-dtd4
  xmlto: add version 0.0.25
  alsa-utils: enable xmlto
  xorg-proto-common.inc: enable xmlto
  xorg-lib-common.inc: enable xmlto
  xserver-xorg.inc: enable xmlto

 meta/conf/licenses.conf                            |   2 +-
 meta/files/common-licenses/XSL                     |  48 ++
 meta/recipes-core/libxml/libxml2.inc               |   2 +
 .../docbook-xml/docbook-xml-dtd4/LICENSE-OASIS     |  16 +
 .../docbook-xml-update-catalog.xml.patch           | 515 +++++++++++++++++++++
 .../docbook-xml/docbook-xml-dtd4/docbook-xml.xml   |  68 +++
 .../docbook-xml/docbook-xml-dtd4_4.5.bb            |  75 +++
 .../docbook-xsl-stylesheets/docbook-xsl.xml        |   6 +
 .../docbook-xml/docbook-xsl-stylesheets_1.78.1.bb  |  67 +++
 meta/recipes-devtools/xmlto/files/catalog.xml      |  19 +
 ....in-drop-the-test-of-xmllint-and-xsltproc.patch |  30 ++
 .../xmlto-0.0.25/obsolete_automake_macros.patch    |  12 +
 meta/recipes-devtools/xmlto/xmlto_0.0.25.bb        |  42 ++
 meta/recipes-graphics/xorg-lib/xorg-lib-common.inc |   6 +-
 .../xorg-proto/xorg-proto-common.inc               |   6 +-
 .../recipes-graphics/xorg-xserver/xserver-xorg.inc |   4 +-
 .../recipes-multimedia/alsa/alsa-utils_1.0.27.2.bb |   4 +-
 17 files changed, 911 insertions(+), 11 deletions(-)
 create mode 100644 meta/files/common-licenses/XSL
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/LICENSE-OASIS
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/docbook-xml-update-catalog.xml.patch
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xml-dtd4/docbook-xml.xml
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xml-dtd4_4.5.bb
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xsl-stylesheets/docbook-xsl.xml
 create mode 100644 meta/recipes-devtools/docbook-xml/docbook-xsl-stylesheets_1.78.1.bb
 create mode 100644 meta/recipes-devtools/xmlto/files/catalog.xml
 create mode 100644 meta/recipes-devtools/xmlto/xmlto-0.0.25/configure.in-drop-the-test-of-xmllint-and-xsltproc.patch
 create mode 100644 meta/recipes-devtools/xmlto/xmlto-0.0.25/obsolete_automake_macros.patch
 create mode 100644 meta/recipes-devtools/xmlto/xmlto_0.0.25.bb
Otavio Salvador - July 8, 2014, 6:57 p.m.
Hello,

On Tue, Jul 8, 2014 at 6:47 AM, Hongxu Jia <hongxu.jia@windriver.com> wrote:
> The xmlto was shipped from meta-oe, and fixed the defects that
> 'xmlto/xsltproc stylesheets cannot be found even when they are
> installed in sysroot'
>
> The xmlto required docbook-xml-dtd and docbook-xsl-stylesheets,
> we refered debian's docbook-xml-dtd and ubuntu config.
>
> We also enable xmlto for alsa-utils, xorg-proto-common.inc,
> xorg-lib-common.inc, xserver-xorg.inc.
>
> The test is easy, just build alsa-utils.

The commit logs in the patches need to be extended. Please bear on
mind that people does not have the cover letter when reading the 'git
log' and thus all important information needs to be added in each
commit.

I also don't see /why/ this is being done. Please clarify.
Ross Burton - July 8, 2014, 9:33 p.m.
On 8 July 2014 10:47, Hongxu Jia <hongxu.jia@windriver.com> wrote:
> The xmlto was shipped from meta-oe, and fixed the defects that
> 'xmlto/xsltproc stylesheets cannot be found even when they are
> installed in sysroot'
>
> The xmlto required docbook-xml-dtd and docbook-xsl-stylesheets,
> we refered debian's docbook-xml-dtd and ubuntu config.
>
> We also enable xmlto for alsa-utils, xorg-proto-common.inc,
> xorg-lib-common.inc, xserver-xorg.inc.

Presumably the goal here is to enable documentation generation?  I'd
say what we want is more complicated than a blanket "--with-xmlto" and
comes back to the same points I raised when the doxygen patch was
submitted.

Native packages never need to build documentation, as nobody is going
to read it.  We've made steps in this direction with the texinfo class
that stubs makeinfo for native recipes.

Target packages may want documentation, but may not.  A powerul board
such as a Minnow or Beagle can support development on the target and
having e.g. the X11 protocol documentation available might be
convenient.  A board with no UI and 64MB of RAM isn't going to support
development on the target and every built piece of documentation is
wasted time.

SDK packages do want documentation.  The ability to ship a SDK with a
toolchain, libraries, and exactly the correct documentation for the
libraries is valuable and currently something we can't do.

I'd suggest that we need a global BUILD_DOCUMENTATION variable that
can be overridden per-class so that e.g. native and target recipes
don't build documentation but SDK packages do.  Then along with xmlto
we can add gtk-doc and doxygen, adding the ability to build full API
documentation for the SDKs.

As such this is definitely a two-part series.  Adding xmlto is useful
and I'm genuinely happy that someone who wasn't me managed to get
docbook-xsl working ;) as that's the blocker for gtk-doc support too.
However rnabling xmlto in some recipes globally isn't the right thing
to do and will introduce noticeable regressions in build time for many
classes of users for no reason.

Ross
Otavio Salvador - July 9, 2014, 12:57 a.m.
On Tue, Jul 8, 2014 at 6:33 PM, Burton, Ross <ross.burton@intel.com> wrote:
> On 8 July 2014 10:47, Hongxu Jia <hongxu.jia@windriver.com> wrote:
>> The xmlto was shipped from meta-oe, and fixed the defects that
>> 'xmlto/xsltproc stylesheets cannot be found even when they are
>> installed in sysroot'
>>
>> The xmlto required docbook-xml-dtd and docbook-xsl-stylesheets,
>> we refered debian's docbook-xml-dtd and ubuntu config.
>>
>> We also enable xmlto for alsa-utils, xorg-proto-common.inc,
>> xorg-lib-common.inc, xserver-xorg.inc.
>
> Presumably the goal here is to enable documentation generation?  I'd
> say what we want is more complicated than a blanket "--with-xmlto" and
> comes back to the same points I raised when the doxygen patch was
> submitted.
>
> Native packages never need to build documentation, as nobody is going
> to read it.  We've made steps in this direction with the texinfo class
> that stubs makeinfo for native recipes.
>
> Target packages may want documentation, but may not.  A powerul board
> such as a Minnow or Beagle can support development on the target and
> having e.g. the X11 protocol documentation available might be
> convenient.  A board with no UI and 64MB of RAM isn't going to support
> development on the target and every built piece of documentation is
> wasted time.
>
> SDK packages do want documentation.  The ability to ship a SDK with a
> toolchain, libraries, and exactly the correct documentation for the
> libraries is valuable and currently something we can't do.
>
> I'd suggest that we need a global BUILD_DOCUMENTATION variable that
> can be overridden per-class so that e.g. native and target recipes
> don't build documentation but SDK packages do.  Then along with xmlto
> we can add gtk-doc and doxygen, adding the ability to build full API
> documentation for the SDKs.
>
> As such this is definitely a two-part series.  Adding xmlto is useful
> and I'm genuinely happy that someone who wasn't me managed to get
> docbook-xsl working ;) as that's the blocker for gtk-doc support too.
> However rnabling xmlto in some recipes globally isn't the right thing
> to do and will introduce noticeable regressions in build time for many
> classes of users for no reason.

I second all your concerns and also I add that the commit logs were too pour.

I am really not sure about a global setting is the way to go. I'd be
more included to a PACKAGECONFIG like system.
Hongxu Jia - July 9, 2014, 1:31 a.m.
On 07/09/2014 05:33 AM, Burton, Ross wrote:
> As such this is definitely a two-part series.  Adding xmlto is useful
> and I'm genuinely happy that someone who wasn't me managed to get
> docbook-xsl working;)  as that's the blocker for gtk-doc support too.
> However rnabling xmlto in some recipes globally isn't the right thing
> to do and will introduce noticeable regressions in build time for many
> classes of users for no reason.

Got it, I will send V2 without enable xmlto in some recipes.

//Hongxu