Bug 648633
| Summary: | Review Request: python-sphinx10 - Python documentation generator | ||
|---|---|---|---|
| Product: | [Fedora] Fedora | Reporter: | Michel Lind <michel> |
| Component: | Package Review | Assignee: | Toshio Ernie Kuratomi <a.badger> |
| Status: | CLOSED ERRATA | QA Contact: | Fedora Extras Quality Assurance <extras-qa> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | rawhide | CC: | fedora-package-review, ndbecker2, notting |
| Target Milestone: | --- | Flags: | a.badger:
fedora-review+
kevin: fedora-cvs+ |
| Target Release: | --- | ||
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | python-sphinx10-1.0.4-3.el5 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2010-11-11 22:25:38 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Michel Lind
2010-11-01 19:38:44 UTC
I notice that our main python-sphinx package does not ship LC_MESSAGES/*.po which I have not excluded from python-sphinx10; let me know if you want these to be stripped. Or if we should indeed re-add them to python-sphinx! *** Bug 638152 has been marked as a duplicate of this bug. *** *.po files are a source file, *.mo files are what's actually used so we want to exclude them. I noticed that you also included the *.js translations in the main python-sphinx package which was a good catch... but I think we're losing the marking of the files as language specific files. Taking a look at that. An initial look at this spec looks good except that the language stuff is going to be incorrect... but fixing it will take a bit of patching as the versions will clash if we don't. The main sphinx package puts the language files in /usr/share/locale and /usr/share/sphinx. %find_lang is able to find the files in /usr/share/locale and we manually find the files under /usr/share/sphinx. This package leaves everything in the module directory so find_lang isn't marking them. We can't move them to the same directory as the main sphinx uses as the files would clash with the main sphinx package then... probably have to patch the code to look for them under an alternate name/directory like sphinx10. I can look at making a patch for this package after looking at the main package if you want. (In reply to comment #3) > *.po files are a source file, *.mo files are what's actually used so we want to > exclude them. I noticed that you also included the *.js translations in the > main python-sphinx package which was a good catch... but I think we're losing > the marking of the files as language specific files. Taking a look at that. Is that actually the case? It looks like rpm -ql does not mark the files in the output -- I tried with another package that contains translations (gnome-vfs2) and it does not mark the translation files in the output either. sphinx.lang from the build directory of both the main package and python-sphinx10 definitely has both the .mo and .js files marked with their language codes. > I can look at making a patch for this package after looking at the main package > if you want. I can rework the patch for sphinx10 -- there was a patch in 0.6.5 (merged in 0.6.6) that adds the main locale directory, so I just need to refer to it to find which file to patch. But if you could figure out what's going on with the language marking that'd be great :) Locale files now moved to /usr/share/sphinx-1.0 (for .js files) and /usr/share/locale/*/LC_MESSAGES/sphinx-1.0.mo (for .mo files); I've patched the two places where they are referred to to use the new directories; see Sphinx-1.0.4-localedirs.patch in the SRPM Spec URL: http://salimma.fedorapeople.org/specs/python/python-sphinx10.spec SRPM URL: http://salimma.fedorapeople.org/specs/python/python-sphinx10-1.0.4-2.fc14.src.rpm Okay, you're doing it right :-) I missed that you're using %dir for the directories in %files which is exactly what needs doing. Here's the rpm invocation to check that:
rpm --qf '[%{filelangs} %{filenames}\n]' -qp python-sphinx-1.0.4-3.fc14.noarch.rpm
Yeah, for a while we were actually *not* shipping the .js files at all (somehow nobody noticed). PS the initial -2.fc14.src.rpm upload is missing some directory ownerships; I fixed it without bumping the revision just in time before your comment (05:04 EDT), so you probably have the right one, but just redownload if that's not the case. Good: * Package follows naming guidelines * Package licensed appropriately * Spec file readable * Sources match upstream * locales handled correctly * Not a shared library * No bundled libraries * Package owns all directories and files it creates and nothing else * Permissions set properly * Macros used consistently. * code, not content. * Nothing in %doc affects runtime * Not a GUI * All filenames are utf8 Needswork: * Does not build in koji for EL-5: http://koji.fedoraproject.org/koji/getfile?taskID=2572200&name=build.log I'd just disable man page generation on EL-5 I think. I'll check rpmlint and that it works properly after that's fixed. Everything else looks fine. Turns out there are several more changes needed for EL-5; see spec file for details. I've tested a Koji build for EL-5 and a local build for F-14 Spec URL: http://salimma.fedorapeople.org/specs/python/python-sphinx10.spec SRPM URL: http://salimma.fedorapeople.org/specs/python/python-sphinx10-1.0.4-3.fc14.src.rpm EL-5 build: http://koji.fedoraproject.org/koji/taskinfo?taskID=2572916 - manpage generation disabled - conditionally re-add BuildRoot and %clean section - manually create %{buildroot}%{python_sitelib} since EL-5's easy_install cannot recreate path rpmlint:
python-sphinx10.src: W: spelling-error %description -l en_US reStructuredText -> restructured Text, restructured-text, restructure
python-sphinx10.src: W: spelling-error %description -l en_US indices -> induces, indies, indicts
python-sphinx10.src: W: spelling-error %description -l en_US docstrings -> doc strings, doc-strings, drawstrings
These are false positives
python-sphinx10.src: W: no-cleaning-of-buildroot %clean
python-sphinx10.src: W: no-buildroot-tag
python-sphinx10.src: W: no-%clean-section
Also false positives -- they're there just in conditionals.
python-sphinx10.noarch: E: script-without-shebang /usr/lib/python2.4/site-packages/Sphinx-1.0.4-py2.4.egg/sphinx/themes/epub/static/epub.css
Lots of these. I think it's due to the version of setuptools in RHEL5 installing everything with execute permissions. We probably want to run this in %install:
find %{buildroot}%{python_sitelib} -type f -exec chmod a-x \{\} \;
python-sphinx10.noarch: W: no-manual-page-for-binary sphinx-1.0-quickstart
python-sphinx10.noarch: W: no-manual-page-for-binary sphinx-1.0-autogen
python-sphinx10.noarch: W: no-manual-page-for-binary sphinx-1.0-build
Ignorable -- we can't generate the man pages on EL5.
4 packages and 0 specfiles checked; 68 errors, 16 warnings.
You can go ahead and do the chmod when you import the package. This review request is APPROVED.
Thanks! Will fix the permissions and also make Pygments BR unconditional (not just for EL-5) when importing New Package SCM Request ======================= Package Name: python-sphinx10 Short Description: Python documentation generator Owners: salimma Branches: el5 f13 InitialCC: Git done (by process-git-requests). python-sphinx10-1.0.4-3.el5 has been submitted as an update for Fedora EPEL 5. https://admin.fedoraproject.org/updates/python-sphinx10-1.0.4-3.el5 python-sphinx10-1.0.4-3.fc13 has been submitted as an update for Fedora 13. https://admin.fedoraproject.org/updates/python-sphinx10-1.0.4-3.fc13 python-sphinx10-1.0.4-3.el5 has been pushed to the Fedora EPEL 5 testing repository. If problems still persist, please make note of it in this bug report. If you want to test the update, you can install it with su -c 'yum --enablerepo=updates-testing update python-sphinx10'. You can provide feedback for this update here: https://admin.fedoraproject.org/updates/python-sphinx10-1.0.4-3.el5 python-sphinx10-1.0.4-3.fc13 has been pushed to the Fedora 13 stable repository. If problems still persist, please make note of it in this bug report. python-sphinx10-1.0.4-3.el5 has been pushed to the Fedora EPEL 5 stable repository. If problems still persist, please make note of it in this bug report. |