Bug 769697 - Review Request: nested - A specialized editor focused on creating structured documents
Summary: Review Request: nested - A specialized editor focused on creating structured ...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Susi Lehtola
QA Contact: Fedora Extras Quality Assurance
URL: http://nestededitor.sourceforge.net
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2011-12-21 19:31 UTC by Alejandro_Perez
Modified: 2013-07-17 09:40 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-07-15 11:05:45 UTC
Type: ---
Embargoed:
susi.lehtola: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Alejandro_Perez 2011-12-21 19:31:12 UTC
Spec URL: http://aeperezt.fedorapeople.org/rpmdev/nested.spec
SRPM URL: http://aeperezt.fedorapeople.org/rpmdev/nested-1.2.2-3.fc16.src.rpm
Description: Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc. It is designed to help the user concentrate on writing content without been distracted by format or markup. It offers a rich WYSIWYM interface where the user writes plain text with a lightweight markup language.

Comment 1 Alejandro_Perez 2011-12-21 19:45:14 UTC
 rpmlint nested.spec 
0 packages and 1 specfiles checked; 0 errors, 0 warnings.

Comment 2 Susi Lehtola 2011-12-27 13:00:35 UTC
This looks useful, but the spec file looks like it's been written in quite a hurry and needs some working over.

**

nested.noarch: W: summary-ended-with-dot C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc.
nested.noarch: E: summary-too-long C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc.
nested.noarch: W: name-repeated-in-summary C Nested
nested.noarch: E: description-line-too-long C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc. It is designed to help the user concentrate on writing content without been distracted by format or markup. It offers a rich WYSIWYM interface where the user writes plain text with a lightweight markup language.
nested.noarch: W: incoherent-version-in-changelog 1.2.2-2 ['1.2.2-3.fc16', '1.2.2-3']
nested.noarch: W: invalid-license GPL2+
nested.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/nested/txt2tags.py 0644L /usr/bin/env
nested.noarch: W: no-manual-page-for-binary nested
nested.src: W: summary-ended-with-dot C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc.
nested.src: E: summary-too-long C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc.
nested.src: W: name-repeated-in-summary C Nested
nested.src: E: description-line-too-long C Nested is a specialized editor focused on creating structured documents such as reports, publications, presentations, books, etc. It is designed to help the user concentrate on writing content without been distracted by format or markup. It offers a rich WYSIWYM interface where the user writes plain text with a lightweight markup language.
nested.src: W: invalid-license GPL2+
2 packages and 0 specfiles checked; 5 errors, 8 warnings.

Fix these. Summary should be something like
 A specialized editor focused on creating structured documents
and the description should be line-wrapped.

License tag should read GPLv2+.

**

Drop the tarball_name macro which isn't used anywhere.

**

Drop explicit Requires: python.

**

Change
 Requires: texlive texlive-latex 
to
 Requires: tex(latex)

which is the recommended form.

**

Please buildrequire gettext-devel instead of plain gettext.

**

Drop the if clause in

%if ! (0%{?fedora} > 12 || 0%{?rhel} > 5)
%{!?python_sitelib: %global python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())")}
%endif

since it does not make any sense. The declaration of python_sitelib is enough.

**

Drop the --record=INSTALLED_FILES statement from the install, as it isn't (and should not be) used.

**

Please document the l10 stuff.

**

Please separate the %clean section from the %install section, or you can drop it altogether.

**

Please be more verbose in %files - there's no need to use wildcards.

%{python_sitelib}/nested/
%{python_sitelib}/nested-%{version}-py*.egg-info
%{_bindir}/nested

Also, if you intend to build for EPEL-5, you need the %defattr line.

**

CHANGELOG.txt and LICENSE.txt are missing from %doc.

**

These are my initial comments. When you have addressed these I will perform the full review.

Comment 3 Alejandro_Perez 2011-12-30 19:48:37 UTC
All of your consideration has been notice and fixed
new spec file and srpm at:
http://aeperezt.fedorapeople.org/rpmdev/nested-1.2.2-4.fc16.src.rpm
http://aeperezt.fedorapeople.org/rpmdev/nested.spec

rpmlint -v SPECS/nested.spec SRPMS/nested-1.2.2-4.fc16.src.rpm 
SPECS/nested.spec: I: checking-url http://sourceforge.net/projects/nestededitor/files/nested-1.2.2.tar.gz (timeout 10 seconds)
nested.src: I: checking
nested.src: I: checking-url http://nestededitor.sourceforge.net/ (timeout 10 seconds)
nested.src: I: checking-url http://sourceforge.net/projects/nestededitor/files/nested-1.2.2.tar.gz (timeout 10 seconds)
1 packages and 1 specfiles checked; 0 errors, 0 warnings.

Comment 4 Susi Lehtola 2012-01-01 13:17:28 UTC
rpmlint output:
nested.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/nested/txt2tags.py 0644L /usr/bin/env
nested.noarch: W: no-manual-page-for-binary nested
2 packages and 0 specfiles checked; 1 errors, 1 warnings.

Get rid of the shebang in txt2tags.py. Shebangs aren't necessary in python libraries, since they're not supposed to be run from the shell anyway.

**

The python spec file templates use
 %{__python} setup.py install -O1 --skip-build --root %{buildroot}
as the install command. I would recommend using this form.

**

Please note also that the use of the %{__python} macro is not necessary - you can replace all occurrences with plain "python". Although macros exist for "mv" (%{__mv}), "rm" (%{__rm}) and so on, I find these make the spec file harder to read.

This is, however, just a question of opinion.

**

MUST: The package does not yet exist in Fedora. The Review Request is not a duplicate. OK
MUST: The spec file for the package is legible and macros are used consistently. OK
MUST: The package must be named according to the Package Naming Guidelines. OK
MUST: The spec file name must match the base package %{name}. OK
MUST: The package must be licensed with a Fedora approved license and meet the  Licensing Guidelines. OK
MUST: The License field in the package spec file must match the actual license. OK

MUST: The sources used to build the package must match the upstream source, as provided in the spec URL. OK
cbdc61bf592477116569ddb69cad07d5  nested-1.2.2.tar.gz
cbdc61bf592477116569ddb69cad07d5  ../SOURCES/nested-1.2.2.tar.gz

MUST: The package MUST successfully compile and build into binary rpms. OK
MUST: The spec file MUST handle locales properly. OK
MUST: Optflags are used and time stamps preserved. OK
MUST: Packages containing shared library files must call ldconfig. N/A
MUST: A package must own all directories that it creates or require the package that owns the directory. OK
MUST: Files only listed once in %files listings. OK
MUST: Debuginfo package is complete. N/A
MUST: Permissions on files must be set properly. OK
MUST: Large documentation files must go in a -doc subpackage. N/A
MUST: All relevant items are included in %doc. Items in %doc do not affect runtime of application. OK
MUST: Header files must be in a -devel package. N/A
MUST: Static libraries must be in a -static package. N/A
MUST: If a package contains library files with a suffix then library files ending in .so must go in a -devel package. N/A
MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned, architecture dependent dependency. N/A
MUST: Packages does not contain any .la libtool archives. N/A

MUST: Desktop files are installed properly. NEEDSWORK
- This is a GUI application and really should have a desktop file installed.

MUST: No file conflicts with other packages and no general names. OK
SHOULD: %{?dist} tag is used in release. OK
SHOULD: If the package does not include license text(s) as separate files from upstream, the packager should query upstream to include it. OK
SHOULD: The package builds in mock. OK
EPEL: Clean section exists. OK
EPEL: Buildroot cleaned before install. OK
EPEL: Packages containing pkgconfig(.pc) files must 'Requires: pkgconfig'. N/A

**

Please write a proper desktop file as per http://fedoraproject.org/wiki/Packaging/Guidelines#Desktop_files

and send it upstream for inclusion in the nested distribution tarball.

I believe you can use nested/nested.png (or .svg) as the icon. Install it into %{_datadir}/pixmaps.

Comment 5 Alejandro_Perez 2012-01-04 19:44:55 UTC
Added a patch to remove the sheban issue.
Added man page generated using this package tool documented in the spec file
also added nested.desktop file as Source1

You can review changes at:

http://aeperezt.fedorapeople.org/rpmdev/nested-1.2.2-5.fc16.src.rpm
http://aeperezt.fedorapeople.org/rpmdev/nested.spec

rpmlint results:
rpmlint -v SPECS/nested.spec 
SPECS/nested.spec: I: checking-url http://sourceforge.net/projects/nestededitor/files/nested-1.2.2.tar.gz (timeout 10 seconds)
0 packages and 1 specfiles checked; 0 errors, 0 warnings.

rpmlint -v RPMS/noarch/nested-1.2.2-5.fc16.noarch.rpm 
nested.noarch: I: checking
nested.noarch: I: checking-url http://nestededitor.sourceforge.net/ (timeout 10 seconds)
1 packages and 0 specfiles checked; 0 errors, 0 warnings.


Thanks for you support and advice.

Comment 6 Susi Lehtola 2012-01-04 19:56:58 UTC
I think you didn't quite understand what I said in comment #4. Please don't use macros for mv, rm and so on. They just make the spec file harder to read.

**

Also, don't use mv to install files from the build directory to the buildroot. Use cp or install, instead.

**

Be sure to preserve time stamps using the -p switch to cp and install.

**

Please break %install into columns, it's a mess.

**

Also, please separate the %clean section from %install.

**

Last, you need to properly install the desktop file as in http://fedoraproject.org/wiki/Packaging/Guidelines#Desktop_files.

Comment 7 Susi Lehtola 2012-01-04 19:57:40 UTC
That is: please change "%{__python}" to "python", "%{__mv}" to "mv", "%{__cp}" to cp and so on.

Comment 8 Alejandro_Perez 2012-01-04 20:32:53 UTC
Sorry about the misunderstanding here are the changes

http://aeperezt.fedorapeople.org/rpmdev/nested-1.2.2-6.fc16.src.rpm
http://aeperezt.fedorapeople.org/rpmdev/nested.spec

result from rpmlint

rpmlint -v RPMS/noarch/nested-1.2.2-6.fc16.noarch.rpm 
nested.noarch: I: checking
nested.noarch: I: checking-url http://nestededitor.sourceforge.net/ (timeout 10 seconds)
1 packages and 0 specfiles checked; 0 errors, 0 warnings.

Once again thanks for you support and patients.

Comment 9 Susi Lehtola 2012-01-04 20:58:05 UTC
Much better.

**

You don't need to use both desktop-file-install and desktop-validate; the latter is used when the desktop file is installed by, e.g., "make install".

**

What does patch1 do? It should be documented in the spec file.

...

I see now that the patch removes the shebang from the txt2tags.py file. In this case, the patch should be named, e.g., nested-1.2.2-shebang.patch.

The purpose is twofold: first, it identifies which version the patch was written for, and second, it identifies what the patch does.

Patches are usually prefixed by the name of the package, since in the old days all sources were in the same directory (but this is of course no longer the case).

**

Same goes for sources without source URLs ( http://fedoraproject.org/wiki/Packaging/SourceURL ). In this case:

# Desktop file, sent upstream for inclusion
Source1:	nested.desktop

**

You are missing

BuildRequires: desktop-file-utils

**

I think you should use %F instead of %f in the desktop file; %F supports multiple files to be opened.

Also, I think you should add the Utility; category.

**

AFAIK it is standard Fedora practice to use
 %{_datadir}/man/man1/nested.1.*
instead of
 %{_datadir}/man/man1/nested.1.gz
since it is conceivable that the compression format of man pages might change in the future. But this is nitpicking.

Please address the issues above before import to git, and send the updated desktop file upstream. This package has been

APPROVED

Comment 10 Susi Lehtola 2012-01-04 20:59:21 UTC
Oh, one more thing: the desktop file should simply have

Name=Nested

Comment 11 Alejandro_Perez 2012-01-04 22:13:33 UTC
Thanks suggestions notice and added.

http://aeperezt.fedorapeople.org/rpmdev/nested-1.2.2-7.fc16.src.rpm
http://aeperezt.fedorapeople.org/rpmdev/nested.spec


Thanks

Comment 12 Alejandro_Perez 2012-01-04 22:22:47 UTC
New Package SCM Request
=======================
Package Name: Nested
Short Description: Specialized editor focused on creating structured documents
Owners: aeperezt
Branches: f15 f16 el6
InitialCC:

Comment 13 Gwyn Ciesla 2012-01-05 13:04:14 UTC
Summary package name and SCM request name do not match, please correct.

Comment 14 Susi Lehtola 2012-01-05 13:58:45 UTC
Alejandro: yes, the summary should read
 "A specialized editor focused on creating structured documents"

Also, in the %description, please change the beginning to "An editor" instead of "Editor".

Comment 15 Alejandro_Perez 2012-01-05 14:39:20 UTC
Changes on summary and description done.

Thanks Jussi

Comment 16 Alejandro_Perez 2012-01-05 15:10:08 UTC
New Package SCM Request
=======================
Package Name: nested
Short Description: A specialized editor focused on creating structured documents
Owners: aeperezt
Branches: f15 f16 el6
InitialCC:

Comment 17 Gwyn Ciesla 2012-01-05 16:57:15 UTC
Git done (by process-git-requests).

Comment 18 Susi Lehtola 2013-07-15 11:05:45 UTC
Well, looks like Alejandro forgot to close this one up.


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