F20 System Wide Change: Unversioned Docdirs

Jaroslav Reznik jreznik at redhat.com
Tue Jul 16 10:28:56 UTC 2013

= Proposed System Wide Change: Unversioned Docdirs =

Change owner(s): Ville Skyttä <ville.skytta at iki.fi>

Install package specific documentation to an unversioned subdir in 
== Detailed description ==
Change the per package documentation directory in /usr/share/doc to 
unversioned, just containing the package's name (previously it contained both 
the package's name and its version). rpmbuild already has support for this, by 
setting the %_docdir_fmt macro to %{name} we cover most of the cases. Other 
cases can be grepped through from package specfiles/patches -- grepping for 
_docdir, _defaultdocdir, usr/share/doc and _datadir.*doc should catch almost 
everything. Packages for which multiple versions are intended to be installed 
need to be changed to install their docs into appropriately versioned subdirs, 
for example explicitly using the previous NAME-VERSION scheme. Some of these 
cases, if unaddressed, will also manifest themselves as build failures due to 
files not found at expected locations. 

== Scope ==
Proposal owners: take care of having the %_docdir_fmt macro set to %{name} in 
rpm or redhat-rpm-config, grep through package specfiles and patches identifying 
cases needing special attention. 

Other developers: see if their package explicitly refers to a NAME-VERSION 
subdir in /usr/share/doc, and change those to NAME. 

Release engineering: mass rebuild is required after the %_docdir_fmt macro 

Policies and guidelines: all documentation referring to NAME-VERSION subdirs 
in /usr/share/doc needs to be changed to NAME instead. 

More information about the devel-announce mailing list