Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bugzilla DB migration completed. Please report issues to Infra team via email via infra@gentoo.org or IRC
Bug 719798 - dev-util/catalyst-3.0.9: No examples in doc directory
Summary: dev-util/catalyst-3.0.9: No examples in doc directory
Status: UNCONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Catalyst Developers
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-04-27 12:39 UTC by Ian Pickworth
Modified: 2020-06-19 20:31 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
Patch to include the examples directory in /usr/share/doc/catalyst-{version} (catalyst-examples-patch,316 bytes, patch)
2020-05-20 16:21 UTC, Ian Pickworth
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ian Pickworth 2020-04-27 12:39:26 UTC
I installed catalyst as follows:
Installed versions:  3.0.9(10:10:01 25/04/20)(doc iso system-bootloader -ccache KERNEL="linux" PYTHON_TARGETS="python3_6 -python3_7 -python3_8")

In man catalyst-spec it says:
FILES
       Example specfiles can be found in
       /usr/share/doc/catalyst-3.0.9/examples.

However, this directory does not contain an examples directory after install:
catalyst ~ # tree /usr/share/doc/catalyst-3.0.9/
/usr/share/doc/catalyst-3.0.9/
├── AUTHORS.bz2
├── docbook-xsl.css
├── HOWTO.html
├── README.bz2
└── TODO.bz2

0 directories, 5 files
catalyst ~ # 

I believe it is because the ebuild omits examples for doc use flag:
(From catalyst-3.0.9.ebuild):
python_install_all() {
	distutils-r1_python_install_all
	if use doc; then
		dodoc files/HOWTO.html files/docbook-xsl.css
	fi
}

The spec example files are really useful, could they be included please?



Reproducible: Always

Steps to Reproduce:
1. emerge catalyst
2. look for /usr/share/doc/catalyst-3.0.9/examples

Actual Results:  
/usr/share/doc/catalyst-3.0.9/examples
does not exist

Expected Results:  
/usr/share/doc/catalyst-3.0.9/examples
should exist with contents from https://github.com/gentoo/catalyst/tree/master/examples
Comment 1 Ian Pickworth 2020-05-20 16:21:14 UTC
Created attachment 640574 [details, diff]
Patch to include the examples directory in /usr/share/doc/catalyst-{version}

I have created this patch to include the contents of the examples directory into /usr/share/doc/catalyst-{version}

Tested it on my machine - works.

Patch presented for your consideration.
Comment 2 flysideways 2020-06-19 20:31:04 UTC
I needed to use the same ebuild patch for catalyst-3.0.12. The examples are missing from the repository's ebuild.