[libdbi-devel] [ libdbi-Bugs-3072718 ] Failed to create documentation

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Bugs item #3072718, was opened at 2010-09-21 16:45
Message generated for change (Comment added) made by mhoenicka
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=379806&aid=3072718&group_id=23824

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Closed
Priority: 5
Private: No
Submitted By: Jan Palus (atler_)
Assigned to: Nobody/Anonymous (nobody)
Summary: Failed to create documentation

Initial Comment:
Docs generations fails with:

make[2]: *** No rule to make target `libdbi-versioning.sgml', needed by `programmers-guide.pdf'.  Stop.

Please provide the file or remove it along with "Library and Interface Versions" chapter from programmers guide.

----------------------------------------------------------------------

>Comment By: Markus Hoenicka (mhoenicka)
Date: 2010-09-25 12:23

Message:
The timestamps of my latest driver html doc subdirs show 12 Nov 2008.
FreeBSD isn't always the fastest to upgrade the autotools, and I can't
claim to be cutting edge in terms of upgrading my OS either.

----------------------------------------------------------------------

Comment By: Jan Palus (atler_)
Date: 2010-09-25 12:19

Message:
According to http://git.savannah.gnu.org/cgit/autoconf.git/tree/NEWS it's
been over 4 years since introducing htmldir into autoconf :)

----------------------------------------------------------------------

Comment By: Markus Hoenicka (mhoenicka)
Date: 2010-09-25 12:12

Message:
Now I see what you mean. It appears that I haven't installed the docs for a
while (I usually configure without docs during development). As the docs
are still installed properly on my box, the current behaviour must be due
to some recent changes in the autotools. I'll have to rewrite the doc
install stuff anyway, as the Debian and Ubuntu packagers let me know that
they'd prefer a separate install-doc target.

----------------------------------------------------------------------

Comment By: Jan Palus (atler_)
Date: 2010-09-25 11:18

Message:
Yes, my conclusion came from actual docs installation. I checked fast what
is docdir value for all drivers and I missed htmldir. Now I checked more
throughly and htmldir in deed contains driver subdir, but configure writes
Makefile with its own htmldir expanding to ${docdir} which takes precedence
as its written after your definition. For example:

grep -n 'htmldir[[:space:]]*=' drivers/mysql/Makefile 
247:#htmldir = 
248:htmldir = $(docdir)/dbd_mysql
249:#htmldir = 
250:htmldir = ${docdir}

----------------------------------------------------------------------

Comment By: Markus Hoenicka (mhoenicka)
Date: 2010-09-25 00:11

Message:
Regarding your comment on libdbi-drivers HTML docs. Have you actually
tested installing the docs? The PDF docs share the same directory, but the
HTML docs should end up in separate subdirectories of that dir. This is how
the Makefile was written, and this is also what I observe on my box. If
that doesn't work as expected on your box, we'd have to fix something.

----------------------------------------------------------------------

Comment By: Markus Hoenicka (mhoenicka)
Date: 2010-09-23 22:54

Message:
I've reverted the docs to their previous revisions to reflect the reverted
changes in the function names. Thanks for pointing this out to me.

----------------------------------------------------------------------

Comment By: Jan Palus (atler_)
Date: 2010-09-23 15:29

Message:
One more thing regarding _i vs _r. dbi.h has _r versions of reetntrant
functions but documantion refers to _i names (changes was made not so long
ago). As _r versions exist from some time now and projects may already use
it (mine at least ;) ) I propose to use _r versions (it's also more common
to name it like this) or at least provide macros with _r suffix.

----------------------------------------------------------------------

Comment By: Markus Hoenicka (mhoenicka)
Date: 2010-09-21 22:53

Message:
I've added libdbi-versioning.sgml to the repository. This was my oversight
that it wasn't there in the first place.
As for the libdbi-drivers docs, you have a good point for leaving docs
installation to package maintainers as they end up in stange places quite
often. I'll consider removing the install step for the docs.

----------------------------------------------------------------------

Comment By: Jan Palus (atler_)
Date: 2010-09-21 17:14

Message:
One more thing regarding libdbi-drivers docs, it shouldn't be here but I
don't what to open new bug just for this comment. All drivers share the
same $(docdir) which results in overwritten html files (at least
index.html).

----------------------------------------------------------------------

Comment By: Jan Palus (atler_)
Date: 2010-09-21 17:02

Message:
btw. by convention all doc files are only generated in build tree but not
installed. It is packager's duty to add all needed docs into proper docs
directory. You may consider this approach and add noinst prefix to
documentation.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=379806&aid=3072718&group_id=23824