Bug 187112 - www/davical: option DOCS includes more than docs, i.e., init scripts for DB
Summary: www/davical: option DOCS includes more than docs, i.e., init scripts for DB
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: John Marino
URL:
Keywords:
Depends on:
Blocks: 186502
  Show dependency treegraph
 
Reported: 2014-02-27 16:20 UTC by cjr
Modified: 2014-10-31 15:45 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description cjr 2014-02-27 16:20:01 UTC
www/davical has one option, DOCS.

Under the doc tree, the init scripts for the PostgreSQL DB davical uses reside. When compiling without DOCS, you get a virtually unusable installation.

DOCS should pull in documentation and a package should ship with all necessary files even without DOCS.

Fix: 

1) Separate DOCS from INITSCRIPTS

2) Scrap the option and "force" DOCS installation
How-To-Repeat: 1) Compile with the DOCS options (UN)SET

2) Have a look at the PLIST
Comment 1 Edwin Groothuis freebsd_committer freebsd_triage 2014-02-27 16:20:08 UTC
Maintainer of www/davical,

Please note that PR ports/187112 has just been submitted.

If it contains a patch for an upgrade, an enhancement or a bug fix
you agree on, reply to this email stating that you approve the patch
and a committer will take care of it.

The full text of the PR can be found at:
    http://www.freebsd.org/cgi/query-pr.cgi?pr=ports/187112

-- 
Edwin Groothuis via the GNATS Auto Assign Tool
edwin@FreeBSD.org
Comment 2 Edwin Groothuis freebsd_committer freebsd_triage 2014-02-27 16:20:09 UTC
State Changed
From-To: open->feedback

Awaiting maintainers feedback (via the GNATS Auto Assign Tool)
Comment 3 maurice 2014-02-27 22:21:23 UTC
The current arrangement reflects the historical Davical installation =
approach with minimal changes to fit FreeBSD's approach.=20

Plesae note:

1. The init scripts are mentioned in the post-install instructions so if =
needed it becomes clear that they need to be installed.
2. Installation with docs is the default behaviour unless overridden
3. I have a vague memory that there was in the past no separate DOCS =
installation and this was restructured out during the review process. As =
such I am deferring this to ports team.

Maurice Castro=
Comment 4 John Marino freebsd_committer freebsd_triage 2014-07-11 23:42:30 UTC
I agree with the submitter.
INITSCRIPTS should always be installed, and they shouldn't be part of docs.

I haven't see the port but from the description here it seems wrong currently and the Fix #1 is probably the right approach to fix it.
Comment 5 John Marino freebsd_committer freebsd_triage 2014-07-11 23:43:10 UTC
(repeating for maintainer who fell off CC before)

I agree with the submitter.
INITSCRIPTS should always be installed, and they shouldn't be part of docs.

I haven't see the port but from the description here it seems wrong currently and the Fix #1 is probably the right approach to fix it.
Comment 6 John Marino freebsd_committer freebsd_triage 2014-08-11 10:26:34 UTC
cjr, maintainer isn't responding.
If you provide a patch, I'll move it to "patch-ready"
Comment 7 John Marino freebsd_committer freebsd_triage 2014-10-05 22:39:00 UTC
This is the second www/davical PR that the maintainer didn't respond to, it may be appropriate to reset the maintainership to ports@
Comment 8 maurice 2014-10-06 00:58:23 UTC
Please feel free to reset the maintainership ... with the change of packaging I have not had time to update to properly maintain this port. 

Please be aware that the current request reverses a previous request ... I believe that the docs should never have been separated nor made optional given the way the software is constructed.
Comment 9 John Marino freebsd_committer freebsd_triage 2014-10-06 05:57:00 UTC
(In reply to maurice from comment #8)
> Please feel free to reset the maintainership ... with the change of
> packaging I have not had time to update to properly maintain this port. 

Given that the change in packaging took place over 18 months, I'd say if you couldn't find time then it's appropriate to reset the port.

> Please be aware that the current request reverses a previous request ... I
> believe that the docs should never have been separated nor made optional
> given the way the software is constructed.

I took at a look at the pkg-plist.
The directories $DOCSDIR/scripts, $DOCSDIR/dba and $DOCSDIR/config should be in $EXAMPLESDIR.  If the software installs them in $DOCSDIR, then the maintainer has to either patch the vendor makefile to install them in better locations or override the do-install target in the ports makefile.  We don't accept vendor installations if they are wrong for FreeBSD.  Believe me, a great percentage of ports are installed differently than the vendor intends.  I see nothing special about davical, and it could easily be adjusted to install properly and keep the DOCS option.

I agree with original submitter; there's a problem here.
Comment 10 commit-hook freebsd_committer freebsd_triage 2014-10-06 06:17:19 UTC
A commit references this bug:

Author: marino
Date: Mon Oct  6 06:16:36 UTC 2014
New revision: 370144
URL: https://svnweb.freebsd.org/changeset/ports/370144

Log:
  www/davical: Reset maintainer, but DOCS option still broken

  Per request by the maintainer, Maurice, maintainship is being reset.
  It should be noted that this port is dumping vital non-docs files in
  DOCDIRS which doesn't get install when the DOCS option is off.  The
  dba, scripts, and config subdirectories should be put somewhere else.

  PR:		187112
  Reported by:	cjr (cruwe.de)

Changes:
  head/www/davical/Makefile
Comment 11 John Marino freebsd_committer freebsd_triage 2014-10-06 06:18:49 UTC
Okay, the port is reset.
Looking at the original post, it seems dba is more than an "example", it's part of the port so it should not got to examples dir.  So another place would be appropriate, $DATADIR perhaps.
Comment 12 John Marino freebsd_committer freebsd_triage 2014-10-31 15:27:15 UTC
I've reworked this, take the PR.
Comment 13 commit-hook freebsd_committer freebsd_triage 2014-10-31 15:43:30 UTC
A commit references this bug:

Author: marino
Date: Fri Oct 31 15:43:27 UTC 2014
New revision: 371860
URL: https://svnweb.freebsd.org/changeset/ports/371860

Log:
  www/davical: Reorganize port to fix DOCS option, Fix Mac OS contacts.app

  The DOCS option dumped the critical dba directory along with non-docs
  directories scripts and config into DOCSDIR, which resulted in a broken
  port if the user turned off the DOCS option.

  Reorganize the port to put dba and scripts in DATADIR, and config in
  EXAMPLESDIR and add the EXAMPLES option.  While here, use the @sample
  keyword, clean up @dirrm, and tweak a bit.

  The second PR fixes vcards on DAVICal servers for Mac OS 10.9.

  PR:		187112
  PR:		186502

Changes:
  head/www/davical/Makefile
  head/www/davical/files/patch-htdocs_caldav.php
  head/www/davical/files/pkg-message.in
  head/www/davical/pkg-plist