| |
@@ -3,105 +3,180 @@
|
| |
|
| |
Fedora Packaging Guidelines for PHP addon modules
|
| |
|
| |
+ [#types]
|
| |
== Different types of PHP packages
|
| |
|
| |
There are basically 4 different kinds of PHP modules, which are packaged for Fedora:
|
| |
|
| |
- * http://pecl.php.net[PECL] (PHP Extention Community Library), which are PHP modules usually written in C, which are dynamically loaded by the PHP interpreter on startup.
|
| |
- * http://pear.php.net[PEAR] (PHP Extension and Application Repository), which are reusable components written in PHP, usually classes, which can be used in your own PHP applications and scripts by using e.g. the include() directive.
|
| |
- * Composer registered libraries, which are reusable components written in PHP, usually PSR-O compliant classes, registered on a package registry, most often on https://packagist.org/[Packagist].
|
| |
- * CHANNEL : a package which register a channel. A channel is a repository which provides PHP extensions
|
| |
- * Other package providing PHP extension not handled by PEAR/PECL mechanisms
|
| |
+ * http://pecl.php.net[PECL] (PHP Extension Community Library) modules,
|
| |
+ which are PHP modules usually written in C
|
| |
+ and are dynamically loaded by the PHP interpreter on startup.
|
| |
|
| |
- While upstream used the same package and distribution format for PECL and PEAR, creating RPMs has to take some differences into account.
|
| |
+ * http://pear.php.net[PEAR] (PHP Extension and Application Repository) modules,
|
| |
+ which are reusable components written in PHP, usually classes,
|
| |
+ which can be used in your own PHP applications and scripts
|
| |
+ by using e.g. the `+include()+` directive.
|
| |
|
| |
- 3 channels are defined on installation of php-pear
|
| |
+ * Composer registered libraries,
|
| |
+ which are reusable components written in PHP,
|
| |
+ usually PSR-0 compliant classes,
|
| |
+ registered on a package registry,
|
| |
+ most often on https://packagist.org/[Packagist].
|
| |
|
| |
- * `+pear.php.net+` (alias pear) : the default channel for PHP Extension and Application Repository
|
| |
- * `+pecl.php.net+` (alias pecl) : the default channel for PHP Extension Community Library
|
| |
- * `+__uri+` : Pseudo-channel for static packages
|
| |
+ * CHANNEL : packages which register a channel.
|
| |
+ A channel is a repository which provides PHP extensions.
|
| |
|
| |
- Other channels must be configured at RPM build time and at at RPM installation time.
|
| |
+ * Other packages providing a PHP extension not handled by PEAR/PECL mechanisms.
|
| |
|
| |
+ While upstream uses the same package and distribution format for PECL and PEAR,
|
| |
+ creating RPMs has to take some differences into account.
|
| |
+
|
| |
+ 3 channels are defined on installation of `+php-pear+`:
|
| |
+
|
| |
+ * `+pear.php.net+` (alias `+pear+`) :
|
| |
+ the default channel for PHP Extension and Application Repository
|
| |
+
|
| |
+ * `+pecl.php.net+` (alias `+pecl+`) :
|
| |
+ the default channel for PHP Extension Community Library
|
| |
+
|
| |
+ * `+__uri+` :
|
| |
+ Pseudo-channel for static packages
|
| |
+
|
| |
+ Other channels must be configured at RPM build time
|
| |
+ and at at RPM installation time.
|
| |
+
|
| |
+ [#naming-scheme]
|
| |
== Naming scheme
|
| |
|
| |
- * PECL packages from standard pecl channel should be named php-pecl-PECLPackageName-%\{version}-%\{release}.%\{arch}.rpm.
|
| |
- * PEAR packages from standard pear channel should be named php-pear-PEARPackageName-%\{version}-%\{release}.noarch.rpm.
|
| |
- * CHANNEL packages should be named php-channel-ChannelAlias-%\{version}-%\{release}.noarch.rpm
|
| |
- * Packages from another channel should be named php-ChannelAlias-PackageName-%\{version}-%\{release}.noarch.rpm.
|
| |
- * Composer enabled packages (referenced in packagist.org or another registry) should be named _php-vendor-library-%\{version}-%\{release}.noarch.rpm_ (where "vendor/library" is the known packagist name, "name" attribute in composer.json). When vendor = library, one can be droped (ex symfony/symfony can be named php-symfony).
|
| |
- * Other packages should be named _php-PackageName-%\{version}-%\{release}.%\{arch}.rpm_; %\{arch} can be "noarch" where appropriate.
|
| |
+ * PECL packages from standard pecl channel should be named
|
| |
+ `+php-pecl-PECLPackageName-%{version}-%{release}.%{arch}.rpm+`.
|
| |
+
|
| |
+ * PEAR packages from standard pear channel should be named
|
| |
+ `+php-pear-PEARPackageName-%{version}-%{release}.noarch.rpm+`.
|
| |
|
| |
- Please make sure that a pure PHP package (PEAR, packagist...) is correctly being built for noarch.
|
| |
+ * CHANNEL packages should be named
|
| |
+ `+php-channel-ChannelAlias-%{version}-%{release}.noarch.rpm+`
|
| |
|
| |
- As for other packages, name should only use lowercase, underscore and slash replaced by dash.
|
| |
+ * Packages from another channel should be named
|
| |
+ `+php-ChannelAlias-PackageName-%{version}-%{release}.noarch.rpm+`
|
| |
|
| |
- The PECLPackageName and the PEARPackageName should be consistent with the upstream naming scheme.
|
| |
- The Crack PHP Extension would thus be named _php-pecl-crack_ with the resulting packages being _php-pecl-crack-0.4-1.i386.rpm_ and _php-pecl-crack-0.4-1.src.rpm_.
|
| |
+ * Composer enabled packages
|
| |
+ (referenced in packagist.org or another registry)
|
| |
+ should be named
|
| |
+ `+php-vendor-library-%{version}-%{release}.noarch.rpm+`
|
| |
+ (where `+vendor/library+` is the known packagist name,
|
| |
+ `+name+` attribute in `+composer.json+`).
|
| |
+ When `+vendor+` equals `+library+`, one can be dropped
|
| |
+ (ex `+symfony/symfony+` can be named `+php-symfony+`).
|
| |
|
| |
- Note that applications that happen to be written in PHP do not belong under the php-* namespace.
|
| |
+ * Other packages should be named
|
| |
+ `+php-PackageName-%{version}-%{release}.%{arch}.rpm+`;
|
| |
+ `+%{arch}+` can be `+noarch+` where appropriate.
|
| |
|
| |
+ Please make sure that a pure PHP package (PEAR, packagist...)
|
| |
+ is correctly being built for `+noarch+`.
|
| |
+
|
| |
+ As for other packages,
|
| |
+ name should only use lowercase, underscore and slash replaced by dash.
|
| |
+
|
| |
+ The `+PECLPackageName+` and the `+PEARPackageName+` should be consistent
|
| |
+ with the upstream naming scheme.
|
| |
+ The Crack PHP Extension would thus be named `+php-pecl-crack+`
|
| |
+ with the resulting packages being
|
| |
+ `+php-pecl-crack-0.4-1.i386.rpm+` and `+php-pecl-crack-0.4-1.src.rpm+`.
|
| |
+
|
| |
+ Note that applications that happen to be written in PHP
|
| |
+ do not belong under the `+php-*+` namespace.
|
| |
+
|
| |
+ [#file-placement]
|
| |
== File Placement
|
| |
|
| |
- Non-PEAR PHP software which provides shared libraries should put its PHP source files for such shared libraries in a subfolder of /usr/share/php, named according to the name of the software. For example, a library called "Whizz_Bang" (with a RPM called php-something-Whizz-Bang) would put the PHP source files for its shared libraries in /usr/share/php/Whizz_Bang.
|
| |
+ Non-PEAR PHP software which provides shared libraries
|
| |
+ should put its PHP source files for such shared libraries
|
| |
+ in a subfolder of `+%{_datadir}/php+`,
|
| |
+ named according to the name of the software.
|
| |
+ For example, a library called _Whizz_Bang_
|
| |
+ (with a RPM called `+php-something-Whizz-Bang+`)
|
| |
+ would put the PHP source files for its shared libraries
|
| |
+ in `+%{_datadir}/php/Whizz_Bang+`.
|
| |
+
|
| |
+ A PSR-0 footnote:[https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md[PSR-0]] compliant library
|
| |
+ would put its PHP files in `+%{_datadir}/php/+`
|
| |
|
| |
- A PSR-0 footnote:[https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md[PSR-0]]
|
| |
- compliant library would put its PHP files in /usr/share/php/
|
| |
+ A PSR-4 footnote:[https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md[PSR-4]] compliant library
|
| |
+ would put its PHP files in `+%{_datadir}/php/+`
|
| |
+ in a PSR-0 compliant tree.
|
| |
|
| |
- A PSR-4 footnote:[https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md[PSR-4]] compliant library would put its PHP files
|
| |
- in /usr/share/php/ in a PSR-0 compliant tree.
|
| |
- PEAR documentation provided by upstream are installed in %\{pear_docdir}, should stay there, and must be marked as %doc.
|
| |
+ PEAR documentation provided by upstream are installed in `+%{pear_docdir}+`,
|
| |
+ should stay there,
|
| |
+ and must be marked as `+%doc+`.
|
| |
|
| |
- PECL documentation provided by upstream are installed in %\{pecl_docdir}, should stay there, and must be marked as %doc.
|
| |
+ PECL documentation provided by upstream is installed in `+%{pecl_docdir}+`,
|
| |
+ should stay there,
|
| |
+ and must be marked as `+%doc+`.
|
| |
|
| |
- The composer.json file is not used, and should be installed as %doc as it provides useful information about the package and its dependencies.
|
| |
+ The `+composer.json+` file is not used,
|
| |
+ and should be installed as `+%doc+`
|
| |
+ as it provides useful information about the package and its dependencies.
|
| |
|
| |
+ [#requires-provides]
|
| |
== Requires and Provides
|
| |
|
| |
+ [#requires-provides-pear]
|
| |
=== PEAR Packages from the standard channel/repository
|
| |
|
| |
A PEAR package *MUST* have:
|
| |
|
| |
....
|
| |
- BuildRequires: php-pear(PEAR)
|
| |
- Requires: php-pear(PEAR)
|
| |
- Requires(post): %{__pear}
|
| |
+ BuildRequires: php-pear(PEAR)
|
| |
+ Requires: php-pear(PEAR)
|
| |
+ Requires(post): %{__pear}
|
| |
Requires(postun): %{__pear}
|
| |
- Provides: php-pear(foo) = %{version}
|
| |
+ Provides: php-pear(foo) = %{version}
|
| |
....
|
| |
|
| |
- The virtual provide should match exactly upstream name, including case and underscore, ex: php-pear(Text_Wiki)
|
| |
+ The virtual provide should match exactly upstream name,
|
| |
+ including case and underscore, ex: `+php-pear(Text_Wiki)+`
|
| |
|
| |
- A PEAR package must have all its dependencies available as PEAR packages, so should only requires those using the php-pear(foo) virtual provides. Known exception for unbundled libraries (which are often bundled because not available in any pear channel).
|
| |
+ A PEAR package must have all its dependencies available as PEAR packages,
|
| |
+ so should only requires those using the `+php-pear(foo)+` virtual provides.
|
| |
+ Known exception for unbundled libraries
|
| |
+ (which are often bundled because not available in any PEAR channel).
|
| |
|
| |
+ [#requires-provides-channel]
|
| |
=== Packages for CHANNEL (repository) configuration
|
| |
|
| |
- A CHANNEL package *'MUST* have :
|
| |
+ A CHANNEL package *MUST* have :
|
| |
|
| |
....
|
| |
- Requires: php-pear(PEAR)
|
| |
- Requires(post): %{__pear}
|
| |
+ Requires: php-pear(PEAR)
|
| |
+ Requires(post): %{__pear}
|
| |
Requires(postun): %{__pear}
|
| |
- Provides: php-channel(channelname)
|
| |
+ Provides: php-channel(channelname)
|
| |
....
|
| |
|
| |
+ [#requires-provides-pear-nonstandard]
|
| |
=== PEAR Packages from a non standard channel/repository
|
| |
|
| |
A PEAR package *MUST* have:
|
| |
|
| |
....
|
| |
- BuildRequires: php-channel(channelname)
|
| |
- BuildRequires: php-pear(PEAR)
|
| |
- Requires: php-pear(PEAR)
|
| |
- Requires(post): %{__pear}
|
| |
+ BuildRequires: php-channel(channelname)
|
| |
+ BuildRequires: php-pear(PEAR)
|
| |
+ Requires: php-pear(PEAR)
|
| |
+ Requires(post): %{__pear}
|
| |
Requires(postun): %{__pear}
|
| |
- Requires: php-channel(channelname)
|
| |
- Provides: php-pear(channelname/foo) = %{version}
|
| |
+ Requires: php-channel(channelname)
|
| |
+ Provides: php-pear(channelname/foo) = %{version}
|
| |
....
|
| |
|
| |
+ [#requires-provides-composer]
|
| |
=== Composer registered Packages
|
| |
|
| |
- Each package registered on https://packagist.org/[Packagist] (which is the most widely used registry, so defined as the implicit one) *MUST* have
|
| |
+ Each package registered on https://packagist.org/[Packagist]
|
| |
+ (which is the most widely used registry,
|
| |
+ so defined as the implicit one)
|
| |
+ *MUST* have
|
| |
|
| |
....
|
| |
Provides: php-composer(vendor/library) = %{version}
|
| |
@@ -113,30 +188,60 @@
|
| |
Provides: php-composer(registry_url/vendor/library) = %{version}
|
| |
....
|
| |
|
| |
- The virtual provide should match exactly upstream name, including underscore, ex: php-composer(pear/console_table)
|
| |
+ The virtual provide should match exactly upstream name,
|
| |
+ including underscore,
|
| |
+ ex: `+php-composer(pear/console_table)+`
|
| |
|
| |
- Packages moved from PEAR to Composer/Packagist should also provides php-pear(foo) when needed (used by other pear packages).
|
| |
+ Packages moved from PEAR to Composer/Packagist
|
| |
+ should also Provide `+php-pear(foo)+`
|
| |
+ when needed (used by other PEAR packages).
|
| |
|
| |
- Packages must not require any php-pear(foo), but should use php-composer(pear/foo).
|
| |
+ Packages must not Require any `+php-pear(foo)+`,
|
| |
+ but should use `+php-composer(pear/foo)+`.
|
| |
|
| |
- Composer.json useful attributes (see https://getcomposer.org/doc/04-schema.md[Composer schema documentation])
|
| |
+ `+composer.json+` useful attributes
|
| |
+ (see https://getcomposer.org/doc/04-schema.md[Composer schema documentation])
|
| |
|
| |
- * name
|
| |
- * description : 1 line, could be used as RPM summary attribute
|
| |
- * homepage : could be used as RPM URL attribute
|
| |
- * license
|
| |
- * require : describes mandatory dependencies: PHP version, PHP extensions or other composer libraries, those must be required by the RPM package as php-composer(foo)
|
| |
- * require-dev : describes development dependencies, usually useful a build time (ex: to run unit test), so could appears as BuidRequires
|
| |
- * suggest : describes optional dependencies, so could appears as Requires (packager choice)
|
| |
- * conflict : as RPM Conflicts
|
| |
- * replace : as RPM Obsoletes
|
| |
- * provide : for additional virtual provides, must also be in RPM Provides as php-composer(foo)
|
| |
+ * `+name+`
|
| |
|
| |
- === C extensions (PECL and others)
|
| |
+ * `+description+` : 1 line, could be used as RPM summary attribute
|
| |
+
|
| |
+ * `+homepage+` : could be used as RPM URL attribute
|
| |
+
|
| |
+ * `+license+`
|
| |
+
|
| |
+ * `+require+` :
|
| |
+ describes mandatory dependencies
|
| |
+ PHP version,
|
| |
+ PHP extensions
|
| |
+ or other composer libraries,
|
| |
+ those must be required by the RPM package as `+php-composer(foo)+`
|
| |
+
|
| |
+ * `+require-dev+` :
|
| |
+ describes development dependencies,
|
| |
+ usually useful a build time (ex: to run unit test),
|
| |
+ so could appear as BuidRequires
|
| |
+
|
| |
+ * `+suggest+` :
|
| |
+ describes optional dependencies,
|
| |
+ so could appear as Requires (packager choice)
|
| |
|
| |
- To be certain that a binary extension will run correctly with a particular version of PHP, it is necessary to check that a particular package has both API and ABIs matching the installed version of PHP. The mechanism for doing this has evolved over time and is as follows:
|
| |
+ * `+conflict+` : as RPM Conflicts
|
| |
|
| |
- For *Fedora* (all current versions):
|
| |
+ * `+replace+` : as RPM Obsoletes
|
| |
+
|
| |
+ * `+provide+` :
|
| |
+ for additional virtual provides,
|
| |
+ must also be in RPM Provides as `+php-composer(foo)+`
|
| |
+
|
| |
+ [#requires-provides-c]
|
| |
+ === C extensions (PECL and others)
|
| |
+
|
| |
+ To be certain that a binary extension will run correctly
|
| |
+ with a particular version of PHP,
|
| |
+ it is necessary to check that a particular package
|
| |
+ has both API and ABIs matching the installed version of PHP.
|
| |
+ The mechanism for doing this is as follows:
|
| |
|
| |
....
|
| |
BuildRequires: php-devel
|
| |
@@ -144,9 +249,11 @@
|
| |
Requires: php(api) = %{php_core_api}
|
| |
....
|
| |
|
| |
+ [#requires-provides-pecl]
|
| |
=== PECL Packages
|
| |
|
| |
- PECL extension *MUST* have ABI check (see previous)
|
| |
+ PECL extension *MUST* have ABI check
|
| |
+ (see xref:requires-provides-c[C extensions] above).
|
| |
|
| |
A PECL package *MUST* also have:
|
| |
|
| |
@@ -155,9 +262,11 @@
|
| |
Provides: php-pecl(foo)%{?_isa} = %{version}
|
| |
....
|
| |
|
| |
+ [#requires-provides-pecl-nonstandard]
|
| |
=== PECL Packages from a non standard channel/repository
|
| |
|
| |
- A PECL package from a non standard channel MUST have (instead of previous provides)
|
| |
+ A PECL package from a non standard channel MUST have
|
| |
+ (instead of previous provides)
|
| |
|
| |
....
|
| |
Requires: php-channel(channelname)
|
| |
@@ -165,44 +274,74 @@
|
| |
Provides: php-pecl(channelname/foo)%{?_isa} = %{version}
|
| |
....
|
| |
|
| |
+ [#requires-provides-other]
|
| |
=== Other Packages
|
| |
|
| |
- PHP addons which are neither PEAR nor PECL should require what makes sense (either a base PHP version or a php-api, php(zend-abi) as necessary).
|
| |
+ PHP addons which are neither PEAR nor PECL
|
| |
+ should require what makes sense
|
| |
+ (either a base PHP version or a `+php-api+`, `+php(zend-abi)+` as necessary).
|
| |
|
| |
+ [#requires-provides-httpd]
|
| |
=== Apache requirement
|
| |
|
| |
- A PHP library must not have an explicit Requires on php or httpd, since these libraries could be used with any webserver or any SAPI (php-cli, php-cgi, php-fpm, ...).
|
| |
+ A PHP library must not have an explicit Requires on `+php+` or `+httpd+`,
|
| |
+ since these libraries could be used with any webserver
|
| |
+ or any SAPI (`+php-cli+`, `+php-cgi+`, `+php-fpm+`, ...).
|
| |
|
| |
- Only a PHP web application, which provides a specific Apache httpd configuration, should have a Requires on httpd and mod_php.
|
| |
+ Only a PHP web application,
|
| |
+ which provides a specific Apache httpd configuration,
|
| |
+ should have a Requires on `+httpd+` and `+mod_php+`.
|
| |
|
| |
+ [#requires-provides-extensions]
|
| |
=== Extensions Requires
|
| |
|
| |
- PHP extensions must have a Requires on all of the dependent extensions (php-date, php-gd, php-mbstring, ...). These extensions are virtual Provides of the php sub-packages.
|
| |
+ PHP extensions must have a Requires on all of the dependent extensions
|
| |
+ (`+php-date+`, `+php-gd+`, `+php-mbstring+`, ...).
|
| |
+ These extensions are virtual Provides of the php sub-packages.
|
| |
|
| |
+ [#requires-provides-min-php]
|
| |
=== Requiring a Minimum PHP version
|
| |
|
| |
- If you need to specify a minimum PHP version, the recommended method is to add a Requires: php(language) >= $VERSION (where $VERSION is the minimum PHP version). This works for all released versions of Fedora and RHEL/EPEL-6, but does NOT work for RHEL/EPEL-5. For RHEL/EPEL-5 packages, you will need to use Requires: php-common >= $VERSION.
|
| |
+ If you need to specify a minimum PHP version,
|
| |
+ the recommended method is to add a Requires: `+php(language) >= $VERSION+`
|
| |
+ (where `+$VERSION+` is the minimum PHP version).
|
| |
+
|
| |
+ [#c-pecl-config-file]
|
| |
+ == C extension and PECL package configuration files
|
| |
+
|
| |
+ Each extension should drop a configuration file
|
| |
+ in `+%{php_inidir}+` and/or `+%{php_ztsinidir}+`
|
| |
+ to enable the extension.
|
| |
+ This file must contain the name of the loaded extension.
|
| |
+ The file must use a numeric prefix to ensure correct load order:
|
| |
|
| |
- == C extensions and PECL packages configuration file
|
| |
+ * range 00-19 is reserved for zend_extensions
|
| |
+ (ex: `+10-opcache.ini+`, `+15-xdebug.ini+`, ...)
|
| |
|
| |
- Each extension should drop a configuration file in %\{php_inidir} and/or %\{php_ztsinidir} to enable the extension. This file must contains the name of the loaded extension. The file must use a numeric prefix to ensure correct load order:
|
| |
+ * range 20-39 is reserved for extensions from php sources
|
| |
+ (ex: `+20-pdo.ini+`, `+30-pdo_pgsql.ini+`, ...)
|
| |
|
| |
- * range 00-19 is reserved for zend_extensions (ex: 10-opcache.ini, 15-xdebug.ini...)
|
| |
- * range 20-39 is reserved for extensions from php sources (ex: 20-pdo.ini, 30-pdo_pgsql.ini...)
|
| |
- * range 40-99 is available for other extensions (ex: 40-zip.ini...)
|
| |
+ * range 40-99 is available for other extensions
|
| |
+ (ex: `+40-zip.ini+`, ...)
|
| |
|
| |
+ [#macros-scriptlets]
|
| |
== Macros and scriptlets
|
| |
|
| |
+ [#macros-scriptlets-zts]
|
| |
=== PHP ZTS extension
|
| |
|
| |
- When the Apache HTTPD is run in worker mode (instead of prefork mode), the ZTS (Zend Thread Safe) version of PHP is used.
|
| |
+ When the Apache HTTPD is run in worker mode (instead of prefork mode),
|
| |
+ the ZTS (Zend Thread Safe) version of PHP is used.
|
| |
|
| |
- If an extension maintainer wants to provide a ZTS version of this extension, the maintainer must ensure that:
|
| |
+ If an extension maintainer wants to provide a ZTS version of this extension,
|
| |
+ the maintainer must ensure that:
|
| |
|
| |
* the extension is thread safe
|
| |
* the libraries used by the extension are thread safe
|
| |
|
| |
- The php-devel package in fedora >= 17 (5.4.0) provides the necessary files to build ZTS modules and provides several new helper macros:
|
| |
+ The `+php-devel+` package provides the necessary files
|
| |
+ to build ZTS modules
|
| |
+ and provides several helper macros:
|
| |
|
| |
For standard (NTS) extensions
|
| |
|
| |
@@ -222,15 +361,18 @@
|
| |
%{php_ztsincldir %{_includedir}/php-zts/php
|
| |
....
|
| |
|
| |
- php-devel provides the executables needed during the build of a ZTS extension, which are:
|
| |
+ `+php-devel+` provides the executables needed during the build of a ZTS extension,
|
| |
+ which are:
|
| |
|
| |
- * zts-phpize
|
| |
- * zts-php-config
|
| |
- * zts-php (which is only useful to run the test suite during build)
|
| |
+ * `+zts-phpize+`
|
| |
+ * `+zts-php-config+`
|
| |
+ * `+zts-php+` (which is only useful to run the test suite during build)
|
| |
|
| |
+ [#macros-scriptlets-channel]
|
| |
=== Packages for CHANNEL (repository) configuration
|
| |
|
| |
- Here are some recommended scriptlets for properly registering and unregistering the channel:
|
| |
+ Here are some recommended scriptlets
|
| |
+ for properly registering and unregistering the channel:
|
| |
|
| |
....
|
| |
%post
|
| |
@@ -246,16 +388,17 @@
|
| |
fi
|
| |
....
|
| |
|
| |
+ [#macros-scriptlets-pear]
|
| |
=== PEAR Modules
|
| |
|
| |
- The php-pear package provides several useful macros:
|
| |
+ The `+php-pear+` package provides several useful macros:
|
| |
|
| |
- * %\{pear_phpdir}
|
| |
- * %\{pear_docdir} (This evaluates to %\{_docdir}/pear.)
|
| |
- * %\{pear_testdir}
|
| |
- * %\{pear_datadir}
|
| |
- * %\{pear_xmldir}
|
| |
- * %\{pear_metadir} (This evaluates to %\{pear_phpdir}, except in Fedora 19+, where it evaluates to /var/lib/pear.)
|
| |
+ * `+%{pear_phpdir}+`
|
| |
+ * `+%{pear_docdir}+` (This evaluates to `+%{_docdir}/pear+`.)
|
| |
+ * `+%{pear_testdir}+`
|
| |
+ * `+%{pear_datadir}+`
|
| |
+ * `+%{pear_xmldir}+`
|
| |
+ * `+%{pear_metadir}+` (This evaluates to `+/var/lib/pear+`.)
|
| |
|
| |
These definitions for the .spec should be of interest:
|
| |
|
| |
@@ -267,7 +410,7 @@
|
| |
Requires(postun): %{_bindir}/pear
|
| |
....
|
| |
|
| |
- Be sure you delete any PEAR metadata files at the end of %install:
|
| |
+ Be sure you delete any PEAR metadata files at the end of `+%install+`:
|
| |
|
| |
....
|
| |
rm -rf %{buildroot}/%{pear_metadir}/.??*
|
| |
@@ -280,7 +423,8 @@
|
| |
%{_bindir}/pear install --nodeps --soft --force --register-only %{pear_xmldir}/%{name}.xml >/dev/null ||:
|
| |
....
|
| |
|
| |
- And here are some recommended scriptlets for properly unregistering the module, from the standard channel:
|
| |
+ And here are some recommended scriptlets for properly unregistering the module,
|
| |
+ from the standard channel:
|
| |
|
| |
....
|
| |
%postun
|
| |
@@ -289,7 +433,7 @@
|
| |
fi
|
| |
....
|
| |
|
| |
- From a non standard channel (pear command requires the channel):
|
| |
+ From a non standard channel (`+pear+` command requires the channel):
|
| |
|
| |
....
|
| |
%postun
|
| |
@@ -298,17 +442,20 @@
|
| |
fi
|
| |
....
|
| |
|
| |
+ [#macros-scriptlets-pecl]
|
| |
=== PECL Modules
|
| |
|
| |
- The php-pear package in Fedora Core 5 and above (version 1:1.4.9-1.2) provides several useful macros:
|
| |
+ The `+php-pear+` package provides several useful macros:
|
| |
|
| |
- * %\{pecl_phpdir}
|
| |
- * %\{pecl_docdir}
|
| |
- * %\{pecl_testdir}
|
| |
- * %\{pecl_datadir}
|
| |
- * %\{pecl_xmldir}
|
| |
+ * `+%{pecl_phpdir}+`
|
| |
+ * `+%{pecl_docdir}+`
|
| |
+ * `+%{pecl_testdir}+`
|
| |
+ * `+%{pecl_datadir}+`
|
| |
+ * `+%{pecl_xmldir}+`
|
| |
|
| |
- You may need to define a few additional macros to extract some information from PHP. It is recommended that you use the following:
|
| |
+ You may need to define a few additional macros
|
| |
+ to extract some information from PHP.
|
| |
+ It is recommended that you use the following:
|
| |
|
| |
....
|
| |
%global php_apiver %((echo 0; php -i 2>/dev/null | sed -n 's/^PHP API => //p') | tail -1)
|
| |
@@ -316,9 +463,12 @@
|
| |
%{!?php_extdir: %{expand: %%global php_extdir %(php-config --extension-dir)}}
|
| |
....
|
| |
|
| |
- Module (un)registration is handled automatically by file triggers in the php-pear package.
|
| |
+ Module (un)registration is handled automatically
|
| |
+ by file triggers in the `+php-pear+` package.
|
| |
|
| |
- For older releases, here are some recommended scriptlets for properly registering and unregistering a module:
|
| |
+ For older releases,
|
| |
+ here are some recommended scriptlets
|
| |
+ for properly registering and unregistering a module:
|
| |
|
| |
....
|
| |
BuildRequires: php-pear
|
| |
@@ -335,9 +485,13 @@
|
| |
fi
|
| |
....
|
| |
|
| |
+ [#macros-scriptlets-other]
|
| |
=== Other Modules
|
| |
|
| |
- If your module includes compiled code, you may need to define some macros to extract some information from PHP. It is recommended that you user the following:
|
| |
+ If your module includes compiled code,
|
| |
+ you may need to define some macros
|
| |
+ to extract some information from PHP.
|
| |
+ It is recommended that you user the following:
|
| |
|
| |
....
|
| |
%global php_apiver %((echo 0; php -i 2>/dev/null | sed -n 's/^PHP API => //p') | tail -1)
|
| |
@@ -345,27 +499,33 @@
|
| |
%global php_version %(php-config --version 2>/dev/null || echo 0)
|
| |
....
|
| |
|
| |
+ [#hints]
|
| |
== Additional Hints for Packagers
|
| |
|
| |
+ [#hints-pear-pecl]
|
| |
=== PEAR & PECL Packages
|
| |
|
| |
- The source archive contains a package.xml outside any directory, so you have to use use
|
| |
+ The source archive contains a `+package.xml+` outside any directory,
|
| |
+ so you have to use use
|
| |
|
| |
....
|
| |
%setup -q -c
|
| |
....
|
| |
|
| |
- in your %prep section to avoid writing files to the build root.
|
| |
+ in your `+%prep+` section to avoid writing files to the build root.
|
| |
|
| |
+ [#hints-pear]
|
| |
=== PEAR Packages
|
| |
|
| |
- To create your initial specfile, you can use the default template provided by the rpmdevtools package:
|
| |
+ To create your initial specfile,
|
| |
+ you can use the default template provided by the `+rpmdevtools+` package:
|
| |
|
| |
....
|
| |
rpmdev-newspec -t php-pear php-pear-Foo
|
| |
....
|
| |
|
| |
- Or you can generate one; make sure you have the php-pear-PEAR-Command-Packaging package installed:
|
| |
+ Or you can generate one;
|
| |
+ make sure you have the `+php-pear-PEAR-Command-Packaging+` package installed:
|
| |
|
| |
....
|
| |
pear make-rpm-spec Foo.tgz
|
| |
oturpe
commented 2 years ago
The following tidying is done here:
1. Use semantic linebreaks
2. Fix formatting and grammar
3. Use macros for system paths
4. Remove references to end-of-life Fedora releases
5. Add anchors and an xref
The changes are purely editorial,
the meaning of the guidelines is not changed.
Reviewing is best done commit by commit,
because introducing semantic linebreaks
changes almost every line.