#69 Minor PHP Guildelines Changes for doc files placement
Closed: Fixed None Opened 8 years ago by remi.

PEAR package commonly move doc files from installed folder (/usr/share/pear/doc/foo) to the RPM docdir (/usr/share/doc/php-pear-foo-1.2.3).

There is no Guideline about such a mandatory move.
This move breaks report of installed files ("pear list-files foo" command)

I propose to keep doc in standard pear directory and add in the PHP Guidelines (under Files placement) a simple comment:

''"PEAR documentation provided by upstream are installed in /usr/share/pear/doc, should stay there, and must be marked as %doc"''

If approved, I will take care of fixing the fedora specific stuff in "php-pear-PEAR-Command-Packaging" package.


Per irc discussion, let's use the existing %{pear_docdir} instead, let's consider:

"PEAR documentation provided by upstream are installed in %{pear_docdir}, should stay there, and must be marked as %doc"

I'm against this change. In Fedora, we keep documentation in /usr/share/doc (%{_docdir}) so that it's easy to find. PEAR upstream has their own packaging system, so it's our job to adapt PEAR packages to Fedora. Since PEAR doesn't provide any special commands for viewing package docs and having those docs elsewhere doesn't break any functionality, only listing the manifest, then it's better to configure/patch php-pear to look for docs in %{_docdir}/%{name}-%{version}-%{release}. Additionally, Debian keeps php pear packages documentation in /usr/share/doc, too.

For posterity, I'm +1 for pretty much any proposal that uses %{pear_docdir} consistently and %{pear_docdir} defined sanely (including it's current value).

I'll agree with Rex here.

Replying to [comment:4 rdieter]:

For posterity, I'm +1 for pretty much any proposal that uses %{pear_docdir} consistently and %{pear_docdir} defined sanely (including it's current value).

As am I.

FPC discussed this more and came up with this wording:

To be added to the PHP Guidelines:

PEAR documentation provided by upstream are installed in %{pear_docdir}, should stay there, and must be marked as %doc.

Additionally, the definition of pear_docdir will be defined as %{_docdir}/pear in the appropriate section of the PHP Guidelines.

Votes:
{{{
<geppetto> I would +1 those two things, as one change
<rathann> abadger1999: +1 to that
<rdieter> +1
<racor> -1 for reasons I already elaborated
<abadger1999> +1
<tibbs|h> +1
}}}

limburgher had already left the meeting at this point.

Sorry, though we were done. I'm +1.

Changes need in php-pear package are quite simple (and are ready)
http://remi.fedorapeople.org/pear.patch

which also solves 2 old issues:
* doc files not set as %doc in php-pear
* doc files are in the default include_path

Written up and about to be announced.

Login to comment on this ticket.

Metadata