Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 407057 - net-misc/tor-0.2.2.35 installs man pages only with USE=doc
Summary: net-misc/tor-0.2.2.35 installs man pages only with USE=doc
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Anthony Basile
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-03-06 03:30 UTC by Maxim Kammerer
Modified: 2012-04-04 16:26 UTC (History)
0 users

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 Maxim Kammerer 2012-03-06 03:30:14 UTC
The (strangely named) --enable/disable-asciidoc configure switch enables or disables building of .html pages and .1 man pages. The switch is strangely named, because .1.txt ASCII files already exist in the tarball, and are not generated during make.

These are the files that the ebuild installs only with USE=doc:

/usr/share/doc/tor-0.2.2.35/tor-gencert.html
/usr/share/doc/tor-0.2.2.35/tor.html
/usr/share/doc/tor-0.2.2.35/torify.html
/usr/share/doc/tor-0.2.2.35/tor-resolve.html
/usr/share/man/man1/tor.1.bz2
/usr/share/man/man1/tor-gencert.1.bz2
/usr/share/man/man1/torify.1.bz2
/usr/share/man/man1/tor-resolve.1.bz2

It seems that --enable-asciidoc should be provided to configure unconditionally, and .html files should or should not be installed depending on USE=doc.
Comment 1 Anthony Basile gentoo-dev 2012-03-06 13:46:31 UTC
I don't see a problem here.  USE="doc" installs the man pages and the html, USE="-doc" does not.  The html pages are just the html equivalent of the man pages and so should or should not be installed with them.  So as far as Gentoo is concerned, the USE flag has the correct behavior.

As for the name of the switch.  I have no problems with what they call it.  If you feel strongly about that, then pass a bug upstream.
Comment 2 Maxim Kammerer 2012-03-06 13:55:45 UTC
[-      ] doc - Adds extra documentation (API, Javadoc, etc). It is recommended to enable per package instead of globally

The doc USE flag shouldn't control the man pages, which are installed unconditionally in every other package. Why should tor be an exception?

I don't care about which switch controls the HTML pages, but I (and any other user) expect to have manpages available after an emerge (if the package provides them).

I mentioned the configure switch name because tor installed man pages previously, so I figured that the new switch confused someone.
Comment 3 Anthony Basile gentoo-dev 2012-03-06 14:30:30 UTC
(In reply to comment #2)
> The doc USE flag shouldn't control the man pages, which are installed
> unconditionally in every other package. Why should tor be an exception?

Okay I just bounced this off some other devs.  FEATURES="noman" controls man pages, USE="doc" should then be used only for extra API docs.

The html are mirror images of the man pages, so I have yet to think about whether I want them unconditionally or not.
Comment 4 Anthony Basile gentoo-dev 2012-03-08 16:18:44 UTC
The man pages are now installed unconditionally and USE="doc" has been removed from all but the stabe ebuild: tor-0.2.2.35.ebuild.

I am installing the .html man pages unconditionally too under /usr/share/doc.  Its not hard to remove them, but it does mean having to patch the build system and run eautoreconf.  I'd rather not do that unless there is a good reason.  I would also add USE="html" to control that if needed.
Comment 5 Maxim Kammerer 2012-03-08 16:26:22 UTC
Thanks! I don't think that splitting HTML documentation is worth the effort. Although you wouldn't need to patch the build system, as post-build removal would probably suffice.
Comment 6 M. B. 2012-03-29 06:20:16 UTC
please stabilize.
the bug is trivial and the issue was really annoying to research.
Comment 7 Anthony Basile gentoo-dev 2012-04-04 16:26:37 UTC
(In reply to comment #6)
> please stabilize.
> the bug is trivial and the issue was really annoying to research.

I think we should wait for the next release of tor.