Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 189639 - dev-lang/erlang man pages are not accessible
Summary: dev-lang/erlang man pages are not accessible
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Dirkjan Ochtman (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-08-20 20:34 UTC by Samuel Tesla
Modified: 2016-04-15 04:47 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Samuel Tesla 2007-08-20 20:34:31 UTC
The erlang distribution ships its own man pages, which it expects to be installed in the erlang lib directory (So /usr/lib/erlang/man by default).  These are then accessible via "erl -man foo" and the erlang-mode for emacs has ERLANG-MAN-MODULE and ERLANG-MAN-FUNCTION which also look there.

The current ebuild installs these in /usr/share/man*erl, but provides no way to get to them (that I can find).

The simplest thing, I think, would be to install these where Erlang expects them to be in ERL_LIBDIR/man/man*, since they're not system man-pages, but rather Erlang man-pages (They shouldn't be accessible from man, but should be from "erl -man").

Reproducible: Always

Steps to Reproduce:
1. Install dev-lang/erlang
2. erl -man erl
Actual Results:  
$ erl -man erl
No manual entry for erl


Expected Results:  
$ erl -man erl
...produces a man page.
Comment 1 Christian Faulhammer (RETIRED) gentoo-dev 2007-08-20 20:53:58 UTC
On the other hand I cannot reproduce it.  Neither with 22.1 nor CVS 22.1.50.
Comment 2 Christian Faulhammer (RETIRED) gentoo-dev 2007-08-20 20:54:27 UTC
> On the other hand I cannot reproduce it.  Neither with 22.1 nor CVS 22.1.50.
 
Sorry, wrong bug. :)(In reply to comment #1)

Comment 3 Christian Faulhammer (RETIRED) gentoo-dev 2007-08-21 06:30:45 UTC
Moved to the canonical location, though the build system does have an option named --disable-erlang-mandir which does what we do now manually in connection with ERL_MANEXT=erl.  Anyway, your proposed fix looks better.
Comment 4 Fernando J. Pereda (RETIRED) gentoo-dev 2007-08-23 20:09:24 UTC
(In reply to comment #0)
> The simplest thing, I think, would be to install these where Erlang expects
> them to be in ERL_LIBDIR/man/man*, since they're not system man-pages, but
> rather Erlang man-pages (They shouldn't be accessible from man, but should be
> from "erl -man").

This argument is completely bogus. If something has to be fixed is 'erl -man' to make it look in the proper man directories.

Either that, or we add proper entries in /etc/man.conf so man finds those pages too.

- ferdy
Comment 5 Samuel Tesla 2007-08-23 22:31:15 UTC
(In reply to comment #4)
> This argument is completely bogus. If something has to be fixed is 'erl -man'
> to make it look in the proper man directories.
> 
> Either that, or we add proper entries in /etc/man.conf so man finds those pages
> too.

They aren't system man pages.  'erl -man' is like ri for ruby, or info for elisp, or pydoc for python.  Just because the Erlang/OTP team decided to use the same file format and same sort of display doesn't mean we should put the files in the same place.
Comment 6 Christian Faulhammer (RETIRED) gentoo-dev 2007-08-25 15:30:38 UTC
(In reply to comment #4)
> (In reply to comment #0)
> > The simplest thing, I think, would be to install these where Erlang expects
> > them to be in ERL_LIBDIR/man/man*, since they're not system man-pages, but
> > rather Erlang man-pages (They shouldn't be accessible from man, but should be
> > from "erl -man").
> This argument is completely bogus. If something has to be fixed is 'erl -man'
> to make it look in the proper man directories.

 What I could read from upstream's comments in configure and other sources, it's natural place should be ERL_LIBDIR.  Although there is a configure option --disable-erlang-mandir which falls back to system standard location.
 
> Either that, or we add proper entries in /etc/man.conf so man finds those pages
> too.

 That's something I would consider.
Comment 7 Christian Faulhammer (RETIRED) gentoo-dev 2007-08-25 23:19:52 UTC
To make everyone happy, there is now a 90erlang env.d file installed with -r2 which sets MANPATH accordingly.  No revision bump as I think it is ridicolous to let people compile it for nearly nothing.