Opened 14 months ago

Closed 2 weeks ago

#58460 closed enhancement (fixed)

ccache, ccache-devel: allow installation without asciidoc

Reported by: Russell-Jones-OxPhys (Russell Jones) Owned by: ryandesign (Ryan Schmidt)
Priority: Normal Milestone:
Component: ports Version:
Keywords: Cc: majoc-at-astro (majoc-at-astro)
Port: ccache, ccache-devel

Description

We'd like to install this early in our build process without pulling in too many deps, so I've added a (default) +doc variant.

I've changed

depends_lib         port:zlib \
                    port:autoconf \
                    port:asciidoc

to

depends_lib         port:zlib \
                    port:autoconf

default_variants +doc

variant doc description "Whether to build docs or not" {
	depends_build-append port:asciidoc
}
if {![variant_isset doc]} {
	configure.args-append --disable-man
}

Attachments (2)

Portfile-ccache (1.5 KB) - added by Russell-Jones-OxPhys (Russell Jones) 14 months ago.
ccache portfile with +doc variant
Portfile-ccache.diff (545 bytes) - added by Russell-Jones-OxPhys (Russell Jones) 14 months ago.
Unified diff of changes to ccache Portfile

Download all attachments as: .zip

Change History (13)

Changed 14 months ago by Russell-Jones-OxPhys (Russell Jones)

Attachment: Portfile-ccache added

ccache portfile with +doc variant

comment:1 Changed 14 months ago by majoc-at-astro (majoc-at-astro)

Cc: majoc-at-astro added

comment:2 Changed 14 months ago by Russell-Jones-OxPhys (Russell Jones)

Type: defectenhancement

comment:3 Changed 14 months ago by mf2k (Frank Schima)

Cc: ryandesign@… removed
Owner: set to ryandesign
Status: newassigned
Version: 2.5.4

comment:4 Changed 14 months ago by mf2k (Frank Schima)

Thanks. Per the guidelines, please instead attach a unified diff of the Portfile so we can easily see what changes you are proposing.

Personally I feel that adding a ccache-doc(s) sub-port is the best way to go instead.

Changed 14 months ago by Russell-Jones-OxPhys (Russell Jones)

Attachment: Portfile-ccache.diff added

Unified diff of changes to ccache Portfile

comment:5 Changed 7 months ago by ryandesign (Ryan Schmidt)

Port: ccache-devel added
Status: assignedaccepted
Summary: Enhancement: allow installation of ccache without asciidocccache, ccache-devel: allow installation without asciidoc

Sorry I didn't see this ticket earlier.

I'm highly suspicious of asciidoc and autoconf having been listed as lib dependencies of ccache, without explanation. autoconf was already changed from a lib dep to a build dep as it should be but asciidoc remains declared as a lib dep, which it most likely does not need to be, since it's only used to build the manpages and is not used by ccache at runtime.

comment:6 Changed 7 months ago by ryandesign (Ryan Schmidt)

In cd9de49321c755c9760e06cc6b9a71ebd5a0557b/macports-ports (master):

asciidoc: installs_libs no

See: #58460
See: #59778

comment:7 Changed 7 months ago by ryandesign (Ryan Schmidt)

In ef61db74412546afa46fe3597485b2641ebec6a5/macports-ports (master):

ccache, ccache-devel: asciidoc is a build dep only

See: #58460

comment:8 Changed 7 months ago by ryandesign (Ryan Schmidt)

Now that we've indicated that asciidoc doesn't install any libraries, its license no longer affects the distributability of ccache, and since nothing else prevented its distributability, we now have binary archives of ccache that we can distribute.

And now that we have properly indicated that ccache only needs asciidoc as a build dependency, asciidoc will only be installed if you build ccache from source, but won't be installed if you install a binary of ccache.

Is that sufficient? Or do you still think a variant is needed? Normally manpages are the kind of thing we would always want to install; a doc variant would normally only be used for less-frequently-used documentation.

comment:9 Changed 7 months ago by Russell-Jones-OxPhys (Russell Jones)

Thanks Ryan, LGTM, but would like to confirm with my colleague who'll be back tomorrow.

comment:10 in reply to:  8 Changed 7 months ago by majoc-at-astro (majoc-at-astro)

Replying to ryandesign:

And now that we have properly indicated that ccache only needs asciidoc as a build dependency, asciidoc will only be installed if you build ccache from source, but won't be installed if you install a binary of ccache.

Is that sufficient?

I'm doing a final acceptance test as we speak, but all looks good so far: installing ccache no longer pulls in half the known world to build asciidoc, which is all I was really after. Many thanks.

comment:11 Changed 2 weeks ago by ryandesign (Ryan Schmidt)

Resolution: fixed
Status: acceptedclosed

Now that I've looked at it more closely, I don't think there was any good reason to have added the asciidoc dependency in the first place. It was done when the port was updated to 3.7.1 because the project switched to GitHub and the port was changed to get the source code using an automatically-generated tarball. Git repositories don't usually contain generated files so it's understandable that the port had to run autogen.sh and have a dependency on asciidoc in that case. But I don't know why the port used an automatically-generated tarball when it is preferable to use a release tarball if the project provides them, and ccache does. I switched the port to do that now and removed the asciidoc dependency entirely.

Note: See TracTickets for help on using tickets.