search

varnish / varnish-modules

Collection of Varnish Cache modules (vmods) by Varnish Software
Other
185 stars 86 forks source link

added build requirements to the documentation #20

Closed padan closed 8 years ago

padan commented 8 years ago
aondio commented 8 years ago

Hi, I don't think this belong here.

In case you build Varnish from source, there is already a list of required dependencies: https://www.varnish-cache.org/docs/trunk/installation/install.html. If you build varnish-modules on top of that you should not encounter problems.

In case you install Varnish from packages and then you build varnish-modules against it all you need is already specified in the README.

dridi commented 8 years ago

@aondio I disagree, nobody forces you to build a VMOD using the tools we use. We don't need all the build dependencies required by the varnish source tree (graphviz, libedit, ...) so this is not entirely relevant.

The README currently says:

Source code is built with autotools:

This is a hint that you need to install the usual suspects to get your build working, but it's only a hint.

fgsch commented 8 years ago

@aondio I also think this should be documented as with do with other VMODs. Varnish has been packaged for a very long time so I don't expect people to build it at all. OTOH, this is most likely built from sources so it makes sense to document it.

lkarsten commented 8 years ago

Hi @padan . Thanks for filing this pull request, it helps us improve!

I've added a link to the Varnish documentation where the build requirements are listed. That way we don't have to keep the list updated when/if Varnish add or remove a requirement.

Hopefully this links makes it easier for you and others to install it.

Thanks again.