Bug 652257 - Review Request: focuswriter - A fullscreen, distraction-free writing program
Summary: Review Request: focuswriter - A fullscreen, distraction-free writing program
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Golo Fuchert
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-11-11 13:37 UTC by Jean-Francois Saucier
Modified: 2011-01-02 19:49 UTC (History)
3 users (show)

Fixed In Version: focuswriter-1.3.1-3.fc14
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2011-01-02 19:48:12 UTC
Type: ---
Embargoed:
packages: fedora-review+
j: fedora-cvs+


Attachments (Terms of Use)

Description Jean-Francois Saucier 2010-11-11 13:37:59 UTC
Spec URL: http://jfsaucier.fedorapeople.org/packages/focuswriter.spec
SRPM URL: http://jfsaucier.fedorapeople.org/packages/focuswriter-1.3.1-1.fc13.src.rpm
Description: 
A fullscreen, distraction-free writing program. You can customize your
environment by changing the font, colors, and background image to add ambiance
as you type. FocusWriter features an on-the-fly updating word count, optional
auto-save, optional daily goals, and an interface that hides away to allow you
to focus more clearly; additionally, when you open the program your current
work-in-progress will automatically load and position you at the end of your
document, so that you can immediately jump back in.


rpmlint is silent of all spec, srpm and rpm. The only thing is that it miss some documentation but upstream doesn't seems to provide any.

Here is the koji scratch build :

Rawhide : http://koji.fedoraproject.org/koji/taskinfo?taskID=2592982
F-14 : http://koji.fedoraproject.org/koji/taskinfo?taskID=2593022
F-13 : http://koji.fedoraproject.org/koji/taskinfo?taskID=2593044


Thanks!

Comment 1 Golo Fuchert 2010-11-16 21:54:05 UTC
Some initial comments on the package:
- No need to BuildRequire gcc-c++
  http://fedoraproject.org/wiki/Packaging:Guidelines#Exceptions_2
- %setup -q is sufficient, -n %{name}-%{version} is the standard argument
- PREFIX=%{_prefix} would be better than PREFIX=/usr since the standard
  might be changed one day.
- COPYING, ChangeLog and README should be included as %doc, COPYING is a must.
- Don't forget to update the icon cache when installing new icons:
http://fedoraproject.org/wiki/Packaging:ScriptletSnippets#Icon_Cache

Comment 2 Jean-Francois Saucier 2010-11-24 13:19:34 UTC
Spec URL: http://jfsaucier.fedorapeople.org/packages/focuswriter.spec
SRPM URL:
http://jfsaucier.fedorapeople.org/packages/focuswriter-1.3.1-2.fc13.src.rpm


Thanks for the review, I made all the correction to the package and everything seems to work well.

rpmlint is still silent on spec, srpm, and rpm.

Comment 3 Golo Fuchert 2010-12-14 22:51:03 UTC
Jean-Francois, I just took a quick look and the package looks good to me, I will review it in the next days.
Right now I wonder if you want to package this for Fedora only. If yes, then it should not be necessary to BuildRequire the explicit version 4.6 of qt-devel after the EOL of F12, do you agree? As far as I know 4.6 is already included in F13.

Comment 4 Jean-Francois Saucier 2010-12-15 20:49:59 UTC
I effectively plan to package this for Fedora only at the moment.

Thank you for taking the review for this package.

Comment 5 Golo Fuchert 2010-12-20 19:45:38 UTC
It took me a little longer to review this package because there seem to be some stability issues. However, a F13 64-bit KDE-spin computer was the only case where focuswriter crashed reproduceably, so maybe it's not focuswriter's fault. I will investigate on this further, but because focuswriter seems to run on most machines and the crash maybe caused by an external library here is the official review:

$ rpmlint RPMS/x86_64/focuswriter-1.3.1-2.fc13.x86_64.rpm SRPMS/focuswriter-1.3.1-2.fc13.src.rpm SPECS/focuswriter.spec 
focuswriter.x86_64: W: spelling-error Summary(en_US) fullscreen -> full screen, full-screen, firescreen
focuswriter.x86_64: W: spelling-error %description -l en_US fullscreen -> full screen, full-screen, firescreen

- false positives

focuswriter.x86_64: W: no-manual-page-for-binary focuswriter

- maybe something for the future?

focuswriter.src: W: spelling-error Summary(en_US) fullscreen -> full screen, full-screen, firescreen
focuswriter.src: W: spelling-error %description -l en_US fullscreen -> full screen, full-screen, firescreen

- same false positives again

2 packages and 1 specfiles checked; 0 errors, 5 warnings.

So nothing serious here.

----------------
key:

[+] = ok
[.] = not applicable
[X] = needs work

----------------

[+] MUST: The package must be named according to the Package Naming Guidelines.
[+] MUST: The spec file name must match the base package %{name}.
[+] MUST: The package must meet the Packaging Guidelines.
[+] MUST: The package must be licensed with a Fedora approved license.
    GPLv3+ according to the source file headers
[+] MUST: The License field in the package spec file must match the actual license.
[+] MUST: The file containing the text of the license(s) for the package must be included in %doc.
    COPYING is present
[+] MUST: The spec file must be written in American English.
[+] MUST: The spec file for the package MUST be legible.
[+] MUST: The sources used to build the package must match the upstream source.
    $ md5sum focuswriter-1.3.1-src.tar.bz2.*
    c245fbe9d8cf102c6648e1aac4d4b326  focuswriter-1.3.1-src.tar.bz2.packaged
    c245fbe9d8cf102c6648e1aac4d4b326  focuswriter-1.3.1-src.tar.bz2.upstream
[+] MUST: The package MUST successfully compile and build into binary rpms on
at least one primary architecture.
    koji scratch build:
    http://koji.fedoraproject.org/koji/taskinfo?taskID=2675584    
[.] MUST: If the package does not successfully compile, build or work ...
[+] MUST: All build dependencies must be listed in BuildRequires.
[.] MUST: The spec file MUST handle locales properly.
[.] MUST: Packages storing shared library files (not just symlinks) must call ldconfig in %post and %postun.
[+] MUST: Packages must NOT bundle copies of system libraries.
[.] MUST: If the package is designed to be relocatable, ...
[+] MUST: A package must own all directories that it creates.
[+] MUST: A Fedora package must not list a file more than once in %files.
[+] MUST: Permissions on files must be set properly.
[+] MUST: Each package must consistently use macros.
[+] MUST: The package must contain code, or permissable content.
[.] MUST: Large documentation files must go in a -doc subpackage.
[+] MUST: Files in %doc must not affect the runtime of the application.
[.] MUST: Header files must be in a -devel package.
[.] MUST: Static libraries must be in a -static package.
[.] MUST: library files with a suffix (e.g. libfoo.so.1.1), must go in a -devel package.
[.] MUST: devel packages must require the base package using a fully versioned dependency
[+] MUST: Packages must NOT contain any .la libtool archives.
[+] MUST: Packages containing GUI applications must include a %{name}.desktop file
[+] MUST: .desktop files must be properly installed with desktop-file-install/-validate in the %install section.
[+] MUST: Packages must not own files or directories already owned by other packages.
[+] MUST: All filenames in rpm packages must be valid UTF-8.

[.] SHOULD: If the source package does not include license text(s) as a separate file ...
[+] SHOULD: The reviewer should test that the package builds in mock.
[+] SHOULD: The package should compile and build into binary rpms on all supported architectures.
[X] SHOULD: The reviewer should test that the package functions as described.
    I can crash focuswriter on my F13 64-bit KDE-spin machine by typing too 
    fast or just holding an arbitrary key.
[+] SHOULD: If scriptlets are used, those scriptlets must be sane.
[.] SHOULD: Usually, subpackages other than devel should require the base
package using a fully versioned dependency.
[.] SHOULD: pkgconfig(.pc) should be placed in a -devel pkg. 
[.] SHOULD: If the package has file dependencies outside of /etc, /bin, /sbin,
/usr/bin, or /usr/sbin consider requiring the package which provides the file
instead of the file itself.
[X] SHOULD: your package should contain man pages for binaries/scripts. 

----------------

Comments:

- As I mentioned in comment #3 the version number of qt-devel seems superfluous to me since the EOL of F12.
- I have the feeling that the most common way is to put the %file section _after_ %post, %postun, and %posttrans. This is, however, not required.
- A manpage would be nice to have.
- I will have a closer look on the stability issue, but since I found nobody who could reproduce this behaviour this is not a blocker.

----------------
Package APPROVED
----------------

Comment 6 Jean-Francois Saucier 2010-12-24 01:24:15 UTC
Thanks a lot for the review. I will try to talk with upstream for adding a
manpage to this package as I think it would be useful.

I made the two other changes to the spec file that I will push into git.

Comment 7 Jean-Francois Saucier 2010-12-24 01:25:52 UTC
New Package SCM Request
=======================
Package Name: focuswriter
Short Description: A fullscreen, distraction-free writing program
Owners: jfsaucier
Branches: f13 f14
InitialCC:

Comment 8 Jason Tibbitts 2010-12-24 01:43:33 UTC
Git done (by process-git-requests).

Comment 9 Jean-Francois Saucier 2010-12-24 19:57:11 UTC
I just tested the new package on F-14 x86_64 with KDE desktop with no problem.  However, I don't have a F-13 KDE desktop to test. What I propose is to push the package to bodhi and see what feedback we can get.

Comment 10 Fedora Update System 2010-12-24 22:45:58 UTC
focuswriter-1.3.1-3.fc13 has been submitted as an update for Fedora 13.
https://admin.fedoraproject.org/updates/focuswriter-1.3.1-3.fc13

Comment 11 Fedora Update System 2010-12-24 22:46:48 UTC
focuswriter-1.3.1-3.fc14 has been submitted as an update for Fedora 14.
https://admin.fedoraproject.org/updates/focuswriter-1.3.1-3.fc14

Comment 12 Fedora Update System 2010-12-25 22:23:02 UTC
focuswriter-1.3.1-3.fc14 has been pushed to the Fedora 14 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 focuswriter'.  You can provide feedback for this update here: https://admin.fedoraproject.org/updates/focuswriter-1.3.1-3.fc14

Comment 13 Fedora Update System 2011-01-02 19:48:07 UTC
focuswriter-1.3.1-3.fc13 has been pushed to the Fedora 13 stable repository.  If problems still persist, please make note of it in this bug report.

Comment 14 Fedora Update System 2011-01-02 19:48:56 UTC
focuswriter-1.3.1-3.fc14 has been pushed to the Fedora 14 stable repository.  If problems still persist, please make note of it in this bug report.


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