Bug 1028481 - Review Request: libtsm - Terminal-emulator State Machine
Summary: Review Request: libtsm - Terminal-emulator State Machine
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Mario Blättermann
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
: 1071651 (view as bug list)
Depends On:
Blocks: 1071653
TreeView+ depends on / blocked
 
Reported: 2013-11-08 14:48 UTC by Christopher Meng
Modified: 2014-03-03 02:16 UTC (History)
3 users (show)

Fixed In Version: libtsm-3-1.fc20
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-12-04 06:59:05 UTC
Type: ---
mario.blaettermann: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Christopher Meng 2013-11-08 14:48:33 UTC
Spec URL: http://cicku.me/libtsm.spec
SRPM URL: http://cicku.me/libtsm-3-1.fc21.src.rpm
Description: TSM is a state machine for DEC VT100-VT520 compatible terminal emulators. 
It tries to support all common standards while keeping compatibility to 
existing emulators like xterm, gnome-terminal, konsole...

TSM itself does not provide any rendering nor window management. It is a 
simple plain state machine without any external dependencies. It can be 
used to implement terminal emulators, but also to implement other applications
that need to interpret terminal escape sequences.

This library is very similar to libvte of the gnome project. However, 
libvte is highly bound to GTK+, which makes it unsuitable for non-graphics 
projects that need to parse escape sequences. Instead, TSM tries to restrict 
its API to terminal emulation only. Furthermore, TSM does not try to 
establish a new terminal emulation standard, but instead keeps compatibility 
as close to xterm as possible. This is why the TERM variable can be set to 
xterm-color256 with any TSM based terminal emulator.
Fedora Account System Username: cicku

Comment 1 Christopher Meng 2013-11-08 14:58:28 UTC
COPYING file:

= Authors =

This software was written by:
	David Herrmann <dh.herrmann>
	Ran Benita <ran234>

= Copyright Notice =

This software is licensed under the terms of the MIT license. Please see each
source file for the related copyright notice and license.

If a file does not contain a copright notice, the following license shall
apply:

	Copyright (c) 2011-2013 David Herrmann <dh.herrmann>

	Permission is hereby granted, free of charge, to any person obtaining
	a copy of this software and associated documentation files
	(the "Software"), to deal in the Software without restriction, including
	without limitation the rights to use, copy, modify, merge, publish,
	distribute, sublicense, and/or sell copies of the Software, and to
	permit persons to whom the Software is furnished to do so, subject to
	the following conditions:

	The above copyright notice and this permission notice shall be included
	in all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
	OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
	IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
	CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
	TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
	SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

== Third-Party Source ==

The hash-table implementation in external/htable.* is copied from ccan and
licensed under the conditions of the LGPL-2.1 or later as published by the FSF:

	Author: Rusty Russel <rusty.au>

The wcwidth() implementation in ./external/wcwidth.c is from:

	Markus Kuhn -- 2007-05-26 (Unicode 5.0)

	Permission to use, copy, modify, and distribute this software
	for any purpose and without fee is hereby granted. The author
	disclaims all warranties with regard to this software.

	Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c

UCS-4 to UTF-8 encoding is copied from "terminology":

	Copyright (C) 2012-2012 Carsten Haitzler and various contributors

	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions are
	met:

	1. Redistributions of source code must retain the above copyright
	   notice, this list of conditions and the following disclaimer.
	2. Redistributions in binary form must reproduce the above copyright
	   notice, this list of conditions and the following disclaimer in the
	   documentation and/or other materials provided with the distribution.

	THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
	THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
	ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The "solarized" color palettes in tsm_vte.c are from:

	Copyright (c) 2011 Ethan Schoonover

	Permission is hereby granted, free of charge, to any person obtaining a copy
	of this software and associated documentation files (the "Software"), to deal
	in the Software without restriction, including without limitation the rights
	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	copies of the Software, and to permit persons to whom the Software is
	furnished to do so, subject to the following conditions:

	The above copyright notice and this permission notice shall be included in
	all copies or substantial portions of the Software.

	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	THE SOFTWARE.


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


I'm not sure if I need to acquire exception from FPC.

Comment 2 Mario Blättermann 2013-11-17 19:37:47 UTC
(In reply to Christopher Meng from comment #1)
> 
> == Third-Party Source ==
> 
> The hash-table implementation in external/htable.* is copied from ccan and
> licensed under the conditions of the LGPL-2.1 or later as published by the
> FSF:
> 
> 	Author: Rusty Russel <rusty.au>
> 
> The wcwidth() implementation in ./external/wcwidth.c is from:
> 
> 	Markus Kuhn -- 2007-05-26 (Unicode 5.0)
> 
> 	Permission to use, copy, modify, and distribute this software
> 	for any purpose and without fee is hereby granted. The author
> 	disclaims all warranties with regard to this software.
> 
> 	Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
> 
> UCS-4 to UTF-8 encoding is copied from "terminology":
> 
> 	Copyright (C) 2012-2012 Carsten Haitzler and various contributors
> 
> 	All rights reserved.
> 
> ...
> 
> I'm not sure if I need to acquire exception from FPC.

Regarding the licenses, no exception needed, all is MIT licensed. But the tarball bundles some external stuff (wcwidth) which needs to be investigated. The hash table tests don't go in the final packages, that's why I don't consider it as bundled.

BTW, the *.src.rpm is broken, cannot be extracted properly.

Comment 3 Christopher Meng 2013-11-20 12:55:10 UTC
Ok.

Try again from URLs in the original comment.

Thanks.

Comment 4 Mario Blättermann 2013-11-20 18:17:56 UTC
Scratch build:
http://koji.fedoraproject.org/koji/taskinfo?taskID=6206349

$ rpmlint -i -v *
libtsm.armv7hl: I: checking
libtsm.armv7hl: W: spelling-error %description -l en_US konsole -> console, insole
The value of this tag appears to be misspelled. Please double-check.

libtsm.armv7hl: W: spelling-error %description -l en_US libvte -> liberate
The value of this tag appears to be misspelled. Please double-check.

libtsm.armv7hl: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm.i686: I: checking
libtsm.i686: W: spelling-error %description -l en_US konsole -> console, insole
The value of this tag appears to be misspelled. Please double-check.

libtsm.i686: W: spelling-error %description -l en_US libvte -> liberate
The value of this tag appears to be misspelled. Please double-check.

libtsm.i686: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm.src: I: checking
libtsm.src: W: spelling-error %description -l en_US konsole -> console, insole
The value of this tag appears to be misspelled. Please double-check.

libtsm.src: W: spelling-error %description -l en_US libvte -> liberate
The value of this tag appears to be misspelled. Please double-check.

libtsm.src: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm.src: I: checking-url http://freedesktop.org/software/kmscon/releases/libtsm-3.tar.xz (timeout 10 seconds)
libtsm.x86_64: I: checking
libtsm.x86_64: W: spelling-error %description -l en_US konsole -> console, insole
The value of this tag appears to be misspelled. Please double-check.

libtsm.x86_64: W: spelling-error %description -l en_US libvte -> liberate
The value of this tag appears to be misspelled. Please double-check.

libtsm.x86_64: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-debuginfo.armv7hl: I: checking
libtsm-debuginfo.armv7hl: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-debuginfo.i686: I: checking
libtsm-debuginfo.i686: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-debuginfo.x86_64: I: checking
libtsm-debuginfo.x86_64: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-devel.armv7hl: I: checking
libtsm-devel.armv7hl: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-devel.armv7hl: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

libtsm-devel.i686: I: checking
libtsm-devel.i686: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-devel.i686: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

libtsm-devel.x86_64: I: checking
libtsm-devel.x86_64: I: checking-url http://freedesktop.org/wiki/Software/kmscon/libtsm/ (timeout 10 seconds)
libtsm-devel.x86_64: W: no-documentation
The package contains no documentation (README, doc, etc). You have to include
documentation files.

libtsm.spec: I: checking-url http://freedesktop.org/software/kmscon/releases/libtsm-3.tar.xz (timeout 10 seconds)
10 packages and 1 specfiles checked; 0 errors, 11 warnings.

No real issues, just a few ignorable spelling errors and missing docs in the -devel package.


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

[+] OK
[.] OK, not applicable
[X] needs work
---------------------------------

[+] MUST: rpmlint must be run on the source rpm and all binary rpms the build produces. The output should be posted in the review.
[+] MUST: The package must be named according to the Package Naming Guidelines.
[+] MUST: The spec file name must match the base package %{name}, in the format %{name}.spec unless your package has an exemption.
[+] MUST: The package must meet the Packaging Guidelines.
[+] MUST: The package must be licensed with a Fedora approved license and meet the Licensing Guidelines.
[+] MUST: The License field in the package spec file must match the actual license.
    MIT
[+] MUST: If (and only if) the source package includes the text of the license(s) in its own file, then that file, containing the text of the license(s) for the package must be included in %doc.
[+] 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, as provided in the spec URL. Reviewers should use sha256sum for this task as it is used by the sources file once imported into git. If no upstream URL can be specified for this package, please see the Source URL Guidelines for how to deal with this.
    $ sha256sum *
    114115d84a2bc1802683871ea2d70a16ddeec8d2f8cde89ebd2046d775e6cf07  libtsm-3.tar.xz
    114115d84a2bc1802683871ea2d70a16ddeec8d2f8cde89ebd2046d775e6cf07  libtsm-3.tar.xz.orig

[+] MUST: The package MUST successfully compile and build into binary rpms on at least one primary architecture.
[.] MUST: If the package does not successfully compile, build or work on an architecture, then those architectures should be listed in the spec in ExcludeArch. Each architecture listed in ExcludeArch MUST have a bug filed in bugzilla, describing the reason that the package does not compile/build/work on that architecture. The bug number MUST be placed in a comment, next to the corresponding ExcludeArch line.
[+] MUST: All build dependencies must be listed in BuildRequires, except for any that are listed in the exceptions section of the Packaging Guidelines ; inclusion of those as BuildRequires is optional. Apply common sense.
[.] MUST: The spec file MUST handle locales properly. This is done by using the %find_lang macro. Using %{_datadir}/locale/* is strictly forbidden.
[+] MUST: Every binary RPM package (or subpackage) which stores shared library files (not just symlinks) in any of the dynamic linker's default paths, 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, the packager must state this fact in the request for review, along with the rationalization for relocation of that specific package. Without this, use of Prefix: /usr is considered a blocker.
[+] MUST: A package must own all directories that it creates. If it does not create a directory that it uses, then it should require a package which does create that directory.
[+] MUST: A Fedora package must not list a file more than once in the spec file's %files listings. (Notable exception: license texts in specific situations)
[+] MUST: Permissions on files must be set properly. Executables should be set with executable permissions, for example.
[+] 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. (The definition of large is left up to the packager's best judgement, but is not restricted to size. Large can refer to either size or quantity).
[+] MUST: If a package includes something as %doc, it must not affect the runtime of the application. To summarize: If it is in %doc, the program must run properly if it is not present.
[.] MUST: Static libraries must be in a -static package.
[+] MUST: Development files must be in a -devel package.
[+] MUST: In the vast majority of cases, devel packages must require the base package using a fully versioned dependency: Requires: %{name}%{?_isa} = %{version}-%{release}
[.] MUST: Packages must NOT contain any .la libtool archives, these must be removed in the spec if they are built.
[.] MUST: Packages containing GUI applications must include a %{name}.desktop file, and that file must be properly installed with desktop-file-install in the %install section. If you feel that your packaged GUI application does not need a .desktop file, you must put a comment in the spec file with your explanation.
[+] MUST: Packages must not own files or directories already owned by other packages. The rule of thumb here is that the first package to be installed should own the files or directories that other packages may rely upon. This means, for example, that no package in Fedora should ever share ownership with any of the files or directories owned by the filesystem or man package. If you feel that you have a good reason to own a file or directory that another package owns, then please present that at package review time. 
[+] 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 from upstream, the packager SHOULD query upstream to include it.
[.] SHOULD: The description and summary sections in the package spec file should contain translations for supported Non-English languages, if available.
[+] SHOULD: The reviewer should test that the package builds in mock.
    See Koji build above (which uses Mock anyway).
[+] SHOULD: The package should compile and build into binary rpms on all supported architectures.
[.] SHOULD: The reviewer should test that the package functions as described. A package should not segfault instead of running, for example.
[.] SHOULD: If scriptlets are used, those scriptlets must be sane. This is vague, and left up to the reviewers judgement to determine sanity.
[.] SHOULD: Usually, subpackages other than devel should require the base package using a fully versioned dependency.
[+] SHOULD: The placement of pkgconfig(.pc) files depends on their usecase, and this is usually for development purposes, so should be placed in a -devel pkg. A reasonable exception is that the main pkg itself is a devel tool not installed in a user runtime, e.g. gcc or gdb.
[.] 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.
[.] SHOULD: your package should contain man pages for binaries/scripts. If it doesn't, work with upstream to add them where they make sense.


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

PACKAGE APPROVED

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


Regarding the bundled files, I had a deeper look on them:

I don't consider htable as a project which should be packaged separately. The purpose of CCAN (Comprehensive C Archive Network) is similar to Gnulib: Take a piece of code and use it in your own project. In our special case, that code doesn't land in the final binary. It will be used for testing purposes, so no exception is needed.

A similar case is wcwidth. I don't consider it as a real software project, it is merely a code snippet and no more than that. It doesn't have a project website, a license declaration, a versioning or anything else.

Comment 5 Christopher Meng 2013-11-21 02:18:01 UTC
New Package SCM Request
=======================
Package Name: libtsm
Short Description: Terminal-emulator State Machine
Owners: cicku
Branches: f20 f19

Comment 6 Gwyn Ciesla 2013-11-21 13:03:20 UTC
Git done (by process-git-requests).

Comment 7 Fedora Update System 2013-11-22 02:35:14 UTC
libtsm-3-1.fc19 has been submitted as an update for Fedora 19.
https://admin.fedoraproject.org/updates/libtsm-3-1.fc19

Comment 8 Fedora Update System 2013-11-22 02:36:21 UTC
libtsm-3-1.fc20 has been submitted as an update for Fedora 20.
https://admin.fedoraproject.org/updates/libtsm-3-1.fc20

Comment 9 Fedora Update System 2013-11-23 19:30:14 UTC
libtsm-3-1.fc19 has been pushed to the Fedora 19 testing repository.

Comment 10 Fedora Update System 2013-12-04 06:59:05 UTC
libtsm-3-1.fc19 has been pushed to the Fedora 19 stable repository.

Comment 11 Fedora Update System 2013-12-14 02:45:44 UTC
libtsm-3-1.fc20 has been pushed to the Fedora 20 stable repository.

Comment 12 Christopher Meng 2014-03-03 02:16:02 UTC
*** Bug 1071651 has been marked as a duplicate of this bug. ***


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