1001264 – OpenColorIO : duplicate documentation files / potentially conflicting

Bug 1001264 - OpenColorIO : duplicate documentation files / potentially conflicting

Summary: OpenColorIO : duplicate documentation files / potentially conflicting

Keywords:
Status:	CLOSED CURRENTRELEASE
Alias:	None
Product:	Fedora
Classification:	Fedora
Component:	OpenColorIO
Sub Component:
Version:	rawhide
Hardware:	Unspecified
OS:	Unspecified
Priority:	unspecified
Severity:	unspecified
Target Milestone:	---
Assignee:	Richard Shaw
QA Contact:	Fedora Extras Quality Assurance
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:	F20UnversionedDocDirs
TreeView+	depends on / blocked

Reported:	2013-08-26 19:57 UTC by Michael Schwendt
Modified:	2013-08-28 19:01 UTC (History)
CC List:	1 user (show)
Fixed In Version:
Doc Type:	Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:	2013-08-28 19:01:35 UTC
Type:	---
Dependent Products:

Attachments	(Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Michael Schwendt 2013-08-26 19:57:44 UTC

Duplicate documentation files have been detected in the package
builds for Rawhide and Fedora 20. The likely cause is the unversioned
docdirs change in Fedora 20.

If your package %installs documentation files into %{_docdir}/%{name}/ to
store them in a subpackage, this now conflicts with using the %doc
macro in the base package. Since Fedora 20, the %doc macro installs into
the unversioned %{_docdir}/%{name}/ and includes everything in that
directory. One obvious fix is to decide between either using %doc or
installing into %{_docdir}/%{name}/ manually as explained in the
Packaging tricks Wiki section (for past dist releases and the versioned
docdir).

General discussion of this problem:
https://fedorahosted.org/fpc/ticket/338

Further information:
http://fedoraproject.org/wiki/Changes/UnversionedDocdirs
https://fedoraproject.org/wiki/Packaging_tricks#Installing_documentation:_2_paths

[semi-automated bug report]

[...]

=> OpenColorIO-1.0.8-3.fc20.src.rpm
=> OpenColorIO-1.0.8-3.fc20.i686 in fedora-development-i386
  File conflict with: OpenColorIO-doc-1.0.8-3.fc20.noarch
     /usr/share/doc/OpenColorIO/ChangeLog
     /usr/share/doc/OpenColorIO/LICENSE
     /usr/share/doc/OpenColorIO/README
     /usr/share/doc/OpenColorIO/html/ChangeLog.html
     /usr/share/doc/OpenColorIO/html/CompatibleSoftware.html
     /usr/share/doc/OpenColorIO/html/FAQ.html
     /usr/share/doc/OpenColorIO/html/License.html
     /usr/share/doc/OpenColorIO/html/_images/gn10_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/gnf_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lg10_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lg8_to_vd8.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lgf_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/psicc_itworks.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_open_current_profile.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_proof_setup.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_reveal_profile.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_select_profile.png
     /usr/share/doc/OpenColorIO/html/_sources/ChangeLog.txt
     /usr/share/doc/OpenColorIO/html/_sources/CompatibleSoftware.txt
     /usr/share/doc/OpenColorIO/html/_sources/FAQ.txt
     /usr/share/doc/OpenColorIO/html/_sources/License.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/allocation_vars.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/nuke_default.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_anim.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_pipeline.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_vfx.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorIO.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorTransforms.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorTypes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonAPI.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonTransforms.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonTypes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/coding_guidelines.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/getting_started.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/internal_architecture.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/issues.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/submitting_changes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/usage_examples.txt
     /usr/share/doc/OpenColorIO/html/_sources/downloads.txt
     /usr/share/doc/OpenColorIO/html/_sources/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/installation.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/baking_luts.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/contexts.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/looks.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/tool_overview.txt
     /usr/share/doc/OpenColorIO/html/_static/ajax-loader.gif
     /usr/share/doc/OpenColorIO/html/_static/alert_info_32.png
     /usr/share/doc/OpenColorIO/html/_static/alert_warning_32.png
     /usr/share/doc/OpenColorIO/html/_static/basic.css
     /usr/share/doc/OpenColorIO/html/_static/bg-page.png
     /usr/share/doc/OpenColorIO/html/_static/bullet_orange.png
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_lm10.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_lnf.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_vd16.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/comment-bright.png
     /usr/share/doc/OpenColorIO/html/_static/comment-close.png
     /usr/share/doc/OpenColorIO/html/_static/comment.png
     /usr/share/doc/OpenColorIO/html/_static/doctools.js
     /usr/share/doc/OpenColorIO/html/_static/down-pressed.png
     /usr/share/doc/OpenColorIO/html/_static/down.png
     /usr/share/doc/OpenColorIO/html/_static/file.png
     /usr/share/doc/OpenColorIO/html/_static/jquery.js
     /usr/share/doc/OpenColorIO/html/_static/minus.png
     /usr/share/doc/OpenColorIO/html/_static/ocio.css
     /usr/share/doc/OpenColorIO/html/_static/plus.png
     /usr/share/doc/OpenColorIO/html/_static/pygments.css
     /usr/share/doc/OpenColorIO/html/_static/searchtools.js
     /usr/share/doc/OpenColorIO/html/_static/underscore.js
     /usr/share/doc/OpenColorIO/html/_static/up-pressed.png
     /usr/share/doc/OpenColorIO/html/_static/up.png
     /usr/share/doc/OpenColorIO/html/_static/websupport.js
     /usr/share/doc/OpenColorIO/html/configurations/allocation_vars.html
     /usr/share/doc/OpenColorIO/html/configurations/index.html
     /usr/share/doc/OpenColorIO/html/configurations/nuke_default.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_anim.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_pipeline.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_vfx.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorIO.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorTransforms.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorTypes.html
     /usr/share/doc/OpenColorIO/html/developers/api/index.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonAPI.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonTransforms.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonTypes.html
     /usr/share/doc/OpenColorIO/html/developers/coding_guidelines.html
     /usr/share/doc/OpenColorIO/html/developers/getting_started.html
     /usr/share/doc/OpenColorIO/html/developers/index.html
     /usr/share/doc/OpenColorIO/html/developers/internal_architecture.html
     /usr/share/doc/OpenColorIO/html/developers/issues.html
     /usr/share/doc/OpenColorIO/html/developers/submitting_changes.html
     /usr/share/doc/OpenColorIO/html/developers/usage_examples.html
     /usr/share/doc/OpenColorIO/html/downloads.html
     /usr/share/doc/OpenColorIO/html/genindex.html
     /usr/share/doc/OpenColorIO/html/index.html
     /usr/share/doc/OpenColorIO/html/installation.html
     /usr/share/doc/OpenColorIO/html/objects.inv
     /usr/share/doc/OpenColorIO/html/py-modindex.html
     /usr/share/doc/OpenColorIO/html/search.html
     /usr/share/doc/OpenColorIO/html/searchindex.js
     /usr/share/doc/OpenColorIO/html/userguide/baking_luts.html
     /usr/share/doc/OpenColorIO/html/userguide/contexts.html
     /usr/share/doc/OpenColorIO/html/userguide/index.html
     /usr/share/doc/OpenColorIO/html/userguide/looks.html
     /usr/share/doc/OpenColorIO/html/userguide/tool_overview.html

=> OpenColorIO-1.0.8-3.fc20.src.rpm
=> OpenColorIO-doc-1.0.8-3.fc20.noarch in fedora-development-i386
  File conflict with: OpenColorIO-1.0.8-3.fc20.i686
     /usr/share/doc/OpenColorIO/ChangeLog
     /usr/share/doc/OpenColorIO/LICENSE
     /usr/share/doc/OpenColorIO/README
     /usr/share/doc/OpenColorIO/html/ChangeLog.html
     /usr/share/doc/OpenColorIO/html/CompatibleSoftware.html
     /usr/share/doc/OpenColorIO/html/FAQ.html
     /usr/share/doc/OpenColorIO/html/License.html
     /usr/share/doc/OpenColorIO/html/_images/gn10_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/gnf_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lg10_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lg8_to_vd8.jpeg
     /usr/share/doc/OpenColorIO/html/_images/lgf_to_linear_light.jpeg
     /usr/share/doc/OpenColorIO/html/_images/psicc_itworks.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_open_current_profile.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_proof_setup.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_reveal_profile.png
     /usr/share/doc/OpenColorIO/html/_images/psicc_select_profile.png
     /usr/share/doc/OpenColorIO/html/_sources/ChangeLog.txt
     /usr/share/doc/OpenColorIO/html/_sources/CompatibleSoftware.txt
     /usr/share/doc/OpenColorIO/html/_sources/FAQ.txt
     /usr/share/doc/OpenColorIO/html/_sources/License.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/allocation_vars.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/nuke_default.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_anim.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_pipeline.txt
     /usr/share/doc/OpenColorIO/html/_sources/configurations/spi_vfx.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorIO.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorTransforms.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/OpenColorTypes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/api/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonAPI.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonTransforms.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/bindings/PythonTypes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/coding_guidelines.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/getting_started.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/internal_architecture.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/issues.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/submitting_changes.txt
     /usr/share/doc/OpenColorIO/html/_sources/developers/usage_examples.txt
     /usr/share/doc/OpenColorIO/html/_sources/downloads.txt
     /usr/share/doc/OpenColorIO/html/_sources/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/installation.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/baking_luts.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/contexts.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/index.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/looks.txt
     /usr/share/doc/OpenColorIO/html/_sources/userguide/tool_overview.txt
     /usr/share/doc/OpenColorIO/html/_static/ajax-loader.gif
     /usr/share/doc/OpenColorIO/html/_static/alert_info_32.png
     /usr/share/doc/OpenColorIO/html/_static/alert_warning_32.png
     /usr/share/doc/OpenColorIO/html/_static/basic.css
     /usr/share/doc/OpenColorIO/html/_static/bg-page.png
     /usr/share/doc/OpenColorIO/html/_static/bullet_orange.png
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_lm10.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_lnf.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/clo_res19_vd16.0101.jpg
     /usr/share/doc/OpenColorIO/html/_static/comment-bright.png
     /usr/share/doc/OpenColorIO/html/_static/comment-close.png
     /usr/share/doc/OpenColorIO/html/_static/comment.png
     /usr/share/doc/OpenColorIO/html/_static/doctools.js
     /usr/share/doc/OpenColorIO/html/_static/down-pressed.png
     /usr/share/doc/OpenColorIO/html/_static/down.png
     /usr/share/doc/OpenColorIO/html/_static/file.png
     /usr/share/doc/OpenColorIO/html/_static/jquery.js
     /usr/share/doc/OpenColorIO/html/_static/minus.png
     /usr/share/doc/OpenColorIO/html/_static/ocio.css
     /usr/share/doc/OpenColorIO/html/_static/plus.png
     /usr/share/doc/OpenColorIO/html/_static/pygments.css
     /usr/share/doc/OpenColorIO/html/_static/searchtools.js
     /usr/share/doc/OpenColorIO/html/_static/underscore.js
     /usr/share/doc/OpenColorIO/html/_static/up-pressed.png
     /usr/share/doc/OpenColorIO/html/_static/up.png
     /usr/share/doc/OpenColorIO/html/_static/websupport.js
     /usr/share/doc/OpenColorIO/html/configurations/allocation_vars.html
     /usr/share/doc/OpenColorIO/html/configurations/index.html
     /usr/share/doc/OpenColorIO/html/configurations/nuke_default.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_anim.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_pipeline.html
     /usr/share/doc/OpenColorIO/html/configurations/spi_vfx.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorIO.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorTransforms.html
     /usr/share/doc/OpenColorIO/html/developers/api/OpenColorTypes.html
     /usr/share/doc/OpenColorIO/html/developers/api/index.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonAPI.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonTransforms.html
     /usr/share/doc/OpenColorIO/html/developers/bindings/PythonTypes.html
     /usr/share/doc/OpenColorIO/html/developers/coding_guidelines.html
     /usr/share/doc/OpenColorIO/html/developers/getting_started.html
     /usr/share/doc/OpenColorIO/html/developers/index.html
     /usr/share/doc/OpenColorIO/html/developers/internal_architecture.html
     /usr/share/doc/OpenColorIO/html/developers/issues.html
     /usr/share/doc/OpenColorIO/html/developers/submitting_changes.html
     /usr/share/doc/OpenColorIO/html/developers/usage_examples.html
     /usr/share/doc/OpenColorIO/html/downloads.html
     /usr/share/doc/OpenColorIO/html/genindex.html
     /usr/share/doc/OpenColorIO/html/index.html
     /usr/share/doc/OpenColorIO/html/installation.html
     /usr/share/doc/OpenColorIO/html/objects.inv
     /usr/share/doc/OpenColorIO/html/py-modindex.html
     /usr/share/doc/OpenColorIO/html/search.html
     /usr/share/doc/OpenColorIO/html/searchindex.js
     /usr/share/doc/OpenColorIO/html/userguide/baking_luts.html
     /usr/share/doc/OpenColorIO/html/userguide/contexts.html
     /usr/share/doc/OpenColorIO/html/userguide/index.html
     /usr/share/doc/OpenColorIO/html/userguide/looks.html
     /usr/share/doc/OpenColorIO/html/userguide/tool_overview.html

Comment 1 Richard Shaw 2013-08-26 20:44:40 UTC

Fixed and rebuilt for rawhide and F20.

Comment 2 Michael Schwendt 2013-08-26 20:54:54 UTC

The fix is insufficient and is a no-op:

  %files doc
 -%doc %{_docdir}/%{name}/
 +%{_docdir}/%{name}/

Files below %_docdir are marked as %doc (documentation) automatically. It has never been needed to write "%doc %{_docdir}/%{name}/" instead of just "%{_docdir}/%{name}/".


These two sections conflict:

> %files
> %doc ChangeLog LICENSE README

> %files doc
> %{_docdir}/%{name}/

Comment 3 Richard Shaw 2013-08-26 21:18:05 UTC

It's still not clear to me... Can I call %doc twice? (once per package) Is it just that I can't mix %doc and direct methods?

Comment 4 Michael Schwendt 2013-08-26 21:39:18 UTC

The latter. You can't mix the two methods, if they store the files in the same directory. For Fedora <= 19 that has been the versioned docdir, now it's the unversioned one.

Since Fedora 20, the following happens:

> %files
> %doc ChangeLog LICENSE README

At the end of the %install section, the files ChangeLog, LICENSE and README get copied into %{buildroot}%{_docdir}/%{name}/. When packaging up the binary rpm, the entire directory gets included in the package, regardless of the three files ChangeLog LICENSE README you've specified.

The %files section for the -doc subpackage also includes the entire directory, even the three files ChangeLog LICENSE README from the base package %doc line:

> %files doc
> %{_docdir}/%{name}/

Comment 5 Richard Shaw 2013-08-28 19:01:35 UTC

Ok, went with the move method and used %doc in both packages. Should be fixed this time.

Note You need to log in before you can comment on or make changes to this bug.