Opened 3 years ago

Closed 7 hours ago

#19381 closed enhancement (implemented)

wish: conditionally build man page (tor.1) and html doc using independent configure options

Reported by: toralf Owned by: atagar
Priority: Medium Milestone: Tor: 0.4.2.x-final
Component: Core Tor/Tor Version:
Severity: Minor Keywords: easy docs lorax tor-docs build autotools, nickm-merge
Cc: jryans@… Actual Points:
Parent ID: Points: .2
Reviewer: dgoulet Sponsor:

Description

Currently it is practice in Gentoo Linux to install at least the the man page.
However that creation is coupled to the html files too (right ?) and therefore forces the Tor package to pull in more - otherwise completely unneeded - dependent packages.

De-coupling tor.1 from the html docs would at least allow us in the Gentoo Linux universe to get rid of packages like libxslt and friends at a dedicated Tor relay.

Child Tickets

Change History (13)

comment:1 Changed 3 years ago by toralf

Summary: wish: conditionally build man page (tor.1) and html doc using independend configure optionswish: conditionally build man page (tor.1) and html doc using independent configure options

comment:2 Changed 3 years ago by atagar

Component: Core Tor/DocTorCore Tor/Tor

DocTor is the monitoring framework - sending this on to Nick.

comment:3 Changed 3 years ago by nickm

Keywords: easy docs lorax added
Points: .2

I'd take a patch for this, sure. The right way to do it is to add --disable-html-manual and --disable-manpage options to configure.ac, and use them to subdivide the case in doc/include.am that is currently controlled by USE_ASCIIDOC.

comment:4 Changed 3 years ago by nickm

Milestone: Tor: unspecified

comment:5 Changed 3 years ago by jryans

Cc: jryans@… added

It appears that a2x calls xsltproc even for manpages. The separate configure flags could still be added, but it seems like you'd still need the same libs to create the manpage (if I am following correctly).

comment:6 in reply to:  5 Changed 2 years ago by cypherpunks

Replying to jryans:

It appears that a2x calls xsltproc even for manpages.

The a2x manual backs your claim by listing xsltproc as one of its requisites.

The separate configure flags could still be added, but it seems like you'd still need the same libs to create the manpage (if I am following correctly).

FWIW AsciiDoc generates the html documentation and a2x generates the manpages. a2x depends on AsciiDoc (see the manual link above) and is part of the AsciiDoc package. I don't see how the dependencies are decreased by introducing the proposed configure options.

comment:7 Changed 2 years ago by nickm

Keywords: tor-docs build autotools added

comment:8 Changed 2 days ago by rl1987

Status: newneeds_review

https://github.com/torproject/tor/pull/1115

I think this is worthwhile to have for making build times slightly shorter, esp. on CI.

comment:9 Changed 2 days ago by nickm

Milestone: Tor: unspecifiedTor: 0.4.2.x-final

comment:10 in reply to:  8 Changed 42 hours ago by teor

Replying to rl1987:

https://github.com/torproject/tor/pull/1115

I think this is worthwhile to have for making build times slightly shorter, esp. on CI.

This change won't impact CI:

We only do one asciidoc build on Travis, to check that we haven't broken the doc build:
https://github.com/torproject/tor/blob/master/.travis.yml#L30
https://github.com/torproject/tor/blob/master/.travis.yml#L50

We disable asciidoc on Appveyor:
https://github.com/torproject/tor/blob/master/.appveyor.yml#L85

comment:11 Changed 30 hours ago by dgoulet

Keywords: nickm-merge added
Status: needs_reviewmerge_ready

Ok this patch lgtm.

disable-asciidoc still disables everything but because it is on by default, then a disable html pages or manpages will work properly.

comment:12 Changed 30 hours ago by dgoulet

Reviewer: dgoulet

comment:13 Changed 7 hours ago by nickm

Resolution: implemented
Status: merge_readyclosed

Merged!

Note: See TracTickets for help on using tickets.