|
|
Ken Williams wrote:
Hi Randy,
As it stands now, what M::B is *supposed* to be doing is only generating
& installing HTML docs if there's somewhere to put them, i.e. if
$Config{installhtmldir} is set or if --install_path html=/some/path is
given. Are you seeing deviant behavior?
Looking at the code, I'm a little puzzled by why things would get
installed into $install_path/site/lib/$module. Maybe it's some funny
way we're using File::Spec?
I keep forgetting that my Config.pm has been customized from the
default, amoung other things my Config.pm on Windows does define paths
for man and html pages, which is why they are both generated and
installed by default. Regardless, whether $Config, 'install_path',
'install_base', etc is set, the pages are going to the wrong place.
Under Windows, in an ActiveState installation (hmm, also wondering about
other platforms with ActiveState installs...), the documentation system
they use expect generated html to go in <perl-root>\html\. And from that
point it mirrors the installation path of the module. Eg. if you install
M::B into 'site' you'd get <perl-root>\html\site\lib\Module\Build.html
or if you installed into 'priv' the docs would go into
<perl-root>\html\site\lib\Module\Build.html.
However, on Unixish I'd expect something completely different, something
that echos the naming of manpages: <htmldir>\Module::Build.html
I'm still not sure what the correct behavior would be for a Windows
install outside of <perl-root>. Maybe the same as on unixish???
I wonder how few people are using the html docs anyway... It's probably
more useful for the PPM generation than anything else. Not that we
should eliminate it, but just wondering.
Randy.
On Nov 30, 2004, at 6:46 PM, Randy W. Sims wrote:
What is the right thing to do when installing html docs from
Module::Build? During a normal install:
perl Build install
M::B does the right thing it generates the html docs referencing any
other docs in <perl>\html\site\lib\<module> directory tree and
installing the generated pages into that tree. But when installed with
a different install base:
perl Build install install_base=X:\home\randys
The generated docs get installed into: X:\home\randys\site\lib\<module>
If given an 'install_base', I think we must assume that the <perl>
directory is off limits. Maybe it's on a read-only file system or
access control prevents the user from accessing that directory tree.
That leaves two options: 1) install into something like
<install_base>\html or <install_base>\man\html, or 2) supress
installation of html docs.
Note that with either of the two suggested options,
ActivePerl::DocTools will NOT include the generated docs in its index.
But I don't believe there is nothing we can reasonably do about that.
_______________________________________________
ActivePerl mailing list
ActivePerl@xxxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe: http://listserv.ActiveState.com/mailman/mysubs
|
|