| Line 5: | Line 5: | ||
'''Proposed:''' Documentation packages be named with the OS version number in the package name to allow parallel installation of multiple versions. | '''Proposed:''' Documentation packages be named with the OS version number in the package name to allow parallel installation of multiple versions. | ||
'''Example:''' fedora-security-guide-11-en-US | '''Example:''' <code>fedora-security-guide-11-en-US</code> | ||
'''Rationale:''' There are several use cases where installing multiple versions of documentation on the same system is desirable. | '''Rationale:''' There are several use cases where installing multiple versions of documentation on the same system is desirable. | ||
Revision as of 02:41, 30 March 2009
Proposed Packaging Guidelines for Documentation Packages generated by Publican
Package naming convention
Proposed: Documentation packages be named with the OS version number in the package name to allow parallel installation of multiple versions.
Example: fedora-security-guide-11-en-US
Rationale: There are several use cases where installing multiple versions of documentation on the same system is desirable.
See:
- https://bugzilla.redhat.com/show_bug.cgi?id=476471#c57
- https://www.redhat.com/archives/fedora-docs-list/2009-March/msg00154.html
Desktop .spec file
Proposed: Allow the Desktop entry to be included inline in the %install section of the .spec file rather than require it as a separate file.
Example:
%install
rm -rf $RPM_BUILD_ROOT
mkdir -p $RPM_BUILD_ROOT%{_datadir}/applications
cat > %{name}.desktop <<'EOF'
[Desktop Entry]
Name=fedora 11: security-guide
Comment=A Guide to Securing Fedora Linux
Exec=%{viewer} %{_docdir}/%{name}-%{version}/index.html
Icon=%{_docdir}/%{name}-%{version}/images/icon.svg
Categories=Documentation;X-Red-Hat-Base;
Type=Application
Encoding=UTF-8
Terminal=false
EOF
Rationale: Publican is an automated tool that handles rpm generation from source for English and multiple language translations. To duplicate the volume of work that Publican does using a manual process would be hugely inefficient (and greatly prone to error). Currently we don't have resources to modify the output of Publican to separate the desktop entry out of the spec file.
See: