This conversation is a fun read! But don't worry really no point removing the docs from the source package or the pre-compiled packages. Including it is painless at this point. If you're curious why, here's the process...
The documentation website source is hosted in our Cisco-Talos/clamav-documentation<https://github.com/Cisco-Talos/clamav-documentation> repo. Any time there is a change to the docs, GitHub Actions automatically re-builds the static site using mdBook and force-pushes it to the gh-pages<https://github.com/Cisco-Talos/clamav-documentation/tree/gh-pages> branch to publish it. To include the docs in the source tarball, all we do (Jenkins does) is copy the contents of that branch into the clamav/docs/html<https://github.com/Cisco-Talos/clamav/tree/main/docs/html> directory before building the source package. >From there, the build system takes care of it. The docs/html directory is >bundled into the tarball, and when building the pre-compiled packages, the >html directory is marked for installation and so is included in each package. That also means that if you're not building from the release tarball (i.e. if you're building from a git clone), you won't get an offline copy of the documentation. -Micah Micah Snyder ClamAV Development Talos Cisco Systems, Inc. ________________________________ From: clamav-users <clamav-users-boun...@lists.clamav.net> on behalf of Paul Kosinski via clamav-users <clamav-users@lists.clamav.net> Sent: Tuesday, August 24, 2021 1:22 PM To: clamav-users@lists.clamav.net <clamav-users@lists.clamav.net> Cc: Paul Kosinski <clamav-us...@iment.com> Subject: Re: [clamav-users] ClamAV® blog: ClamAV 0.104.0 Second Release Candidate is here! On Tue, 24 Aug 2021 10:48:48 +0100 (BST) "G.W. Haywood via clamav-users" <clamav-users@lists.clamav.net> wrote: > Hi there, > > On Mon, 23 Aug 2021, Paul Kosinski via clamav-users wrote: > > > On Sun, 22 Aug 2021 14:42:06 +0000 > > "Joel Esler via clamav-users" wrote: > > > >> I’m a fan of the thought of removing the user manual completely > >> from the downloaded packages and including a link to > >> docs.ClamAV.net. Since that’s more dynamic. > > > > I think that's a bad idea for three reasons: > > > > First, the Website might be (temporarily) inaccessible. > > > > Second, the machine running ClamAV may be blocked from accessing the > > Internet ... > > > > Finally, if the documentation is "dynamic", it presumably is for the latest > > release ... > > +1 > > I suspect most ClamAV installations are via packages for the various > distributions. Please think about the distribution package managers. > If the documentation were not included in the release tarballs they'd > have a great deal more work to do, and the opportunities for errors > and confusion would be increased out of all proportion. Good point about the Release Managers. Maybe the GPL should augmented to require docs to be available in the same way as the source code, when GPLed executables are distributed :-) _______________________________________________ clamav-users mailing list clamav-users@lists.clamav.net https://lists.clamav.net/mailman/listinfo/clamav-users Help us build a comprehensive ClamAV guide: https://github.com/vrtadmin/clamav-faq http://www.clamav.net/contact.html#ml
_______________________________________________ clamav-users mailing list clamav-users@lists.clamav.net https://lists.clamav.net/mailman/listinfo/clamav-users Help us build a comprehensive ClamAV guide: https://github.com/vrtadmin/clamav-faq http://www.clamav.net/contact.html#ml
