Debian packaging, CMake and README.md fixes (#683)

* Use https for debian/copyright

* Update dates and fix stanzas in debian/copyright

No need to have 2 stanzas for the same license

* Add BSD-3-clause body in debian/copyright

* Remove generated boilerplate from debian/rules

* Enable compiler hardening flags in debian/rules

* Fix source package name according to repo and docs

* Set source package section to electronics

See https://packages.debian.org/unstable/electronics/ for a full list

* Add long descriptions to packages

* Add gbp.conf file

* Update changelog for 1.5.0 release

* Remove dirs files, not needed anymore

* Rename library package to match SONAME

As per Debian policy, shared library packages must be named after
their SONAME version.

* libstlink0: break+replace libstlink since it took over its files

* Remove triggers, not needed anymore

debhelper tools will generate the triggers file automatically since
the package name was corrected

* List GPL2+ in debian/copyright for flashloaders

* Do not append -shared to shared library on *NIX

Only on Windows it's necessary to have different file names, on *NIX
the extension is what disambiguates between a static library (.a) and
a shared library (.so).

* Clarify license of flashloaders in README.md

Fixes #682

* List all individual authors in debian/copyright

The Debian FTP masters nowadays require that all authors are listed in
debian/copyright. Print the list of authors from git.

* Move modprobe and udev files from shared library package to tools package

Multiple versions of a shared library might be installed on the same
system. Do not ship unversioned files in their packages, or they will
conflict and fail to install.

* stlink-tools: break+replace libstlink

It took ownership of udev and modprobe files from libstlink

* Fix pkgconfig include dir: remove project version

The headers are installed in /usr/include/stlink without a version
number.

* Add libstlink1 symbols file

Generated with:

 dpkg-gensymbols -P/tmp -v1.5.0 -V -e/tmp/libstlink.so.1.5.0
  -plibstlink1 -Odebian/libstlink1.symbols

* Bump Standards-Version to 4.1.3

Main changes are shared library rename and files moved, and HTTPS
URLs.

https://www.debian.org/doc/packaging-manuals/upgrading-checklist.txt

* Add debian/watch file for notifications

The Debian package tracker can automatically notify when a new
version is out.

CMakeLists.txt

@@ -83,7 +83,11 @@ endif ()
 ###
 # Shared library
 ###
+if (NOT WIN32)
+set(STLINK_LIB_SHARED ${PROJECT_NAME})
+else ()
 set(STLINK_LIB_SHARED ${PROJECT_NAME}-shared)
+endif()
 
 add_library(${STLINK_LIB_SHARED} SHARED
 	${STLINK_HEADERS} # header files for ide projects generated by cmake

README.md

@@ -232,5 +232,5 @@ Issue related to this bug: [#545](https://github.com/texane/stlink/issues/545)
 
 ## License
 
-The stlink library and tools are licensed under the [BSD license](LICENSE). With
-some exceptions on external components (e.g flashloaders).
+The stlink library and tools are licensed under the [BSD license](LICENSE).
+The flashloaders/stm32l0x.s and flashloaders/stm32lx.s source files are licensed under the GPL-2+.

debian/changelog

@@ -1,3 +1,62 @@
+stlink (1.5.0) unstable; urgency=medium
+
+  [ Jerry Jacobs ]
+  * README.md: Update version badge to v1.4.0
+
+  [ Viallard Anthony ]
+  * Add support of STM32L496xx/4A6xx devices (#615)
+
+  [ rdlim ]
+  * Fix verification of flash error for STM32L496x device (#617) (#618)
+
+  [ dflogeras ]
+  * Add note about availability in Gentoo package manager (#622)
+
+  [ yaofei zheng ]
+  * update debian package version (#630)
+
+  [ Lyle Cheatham ]
+  * Minor formatting fix in FAQ section of README.md (#631)
+
+  [ Vasiliy Glazov ]
+  * README.md: Added information about Fedora and RedHat/CentOS packages.
+    (#635)
+  * Added LIB_INSTALL_DIR to correct libs install on 64-bit systems (#636)
+
+  [ Gwenhael Goavec-Merou ]
+  * fix write for microcontroler with RAM size less or equal to 32K (#637)
+
+  [ Mateusz Krawiec ]
+  * Fix memory map for stm32l496xx boards. (#639)
+
+  [ Rüdiger Fortanier ]
+  * Add unknown chip output (#641)
+
+  [ Slyshyk Oleksiy ]
+  * fix __FILE__ base name extraction,  #628 (#648)
+
+  [ texane ]
+  * STM32F72xx73xx support, from [email protected]
+
+  [ Kirill Kolyshkin ]
+  * debian/triggers: add (to run ldconfig) (#664)
+
+  [ Slyshyk Oleksiy ]
+  * Try to fix #666 issue (#667)
+  * Try to fix 666 issue (#668)
+
+  [ Jerry Jacobs ]
+  * Update ChangeLog.md
+  * Update README.md
+
+  [ texane ]
+  * STM32F042K6 Nucleo-32 Board reported to work, by [email protected]
+
+  [ Anatol Pomozov ]
+  * Update .version file to match release number (#670)
+
+ -- Anatol Pomozov <[email protected]>  Mon, 19 Feb 2018 11:00:29 -0800
+
 libstlink (1.4.0) unstable; urgency=low
 
   * Major changes and added features

debian/control

@@ -1,34 +1,53 @@
-Source: libstlink
+Source: stlink
 Priority: optional
 Maintainer: Andrew 'Necromant' Andrianov <[email protected]>
 Build-Depends: debhelper (>= 9), cmake, libusb-1.0-0-dev, libgtk-3-dev
-Standards-Version: 3.9.5
-Section: libs
+Standards-Version: 4.1.3
+Section: electronics
 Homepage: https://github.com/texane/stlink
 Vcs-Git: https://github.com/texane/stlink.git
 Vcs-Browser: https://github.com/texane/stlink
 
 Package: libstlink-dev
 Section: libdevel
 Architecture: any
-Depends: libstlink (= ${binary:Version}), ${misc:Depends}
-Description: OpenSource ST-Link tools replacement. Development headers.
-    This package contains development headers for libstlink.
+Depends: libstlink1 (= ${binary:Version}), ${misc:Depends}
+Description: OpenSource ST-Link tools replacement.
+ Flashing tools for STMicroelectronics STM32VL and STM32L. The transport layers
+ STLINKv1 and STLINKv2 are supported.
+ .
+ This package contains the development files for stlink.
 
-Package: libstlink
+Package: libstlink1
+Section: libs
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: OpenSource ST-Link tools replacement. Shared library.
-    This package libstlink shared library.
+Breaks: libstlink
+Replaces: libstlink
+Description: OpenSource ST-Link tools replacement.
+ Flashing tools for STMicroelectronics STM32VL and STM32L. The transport layers
+ STLINKv1 and STLINKv2 are supported.
+ .
+ This package contains the shared library for stlink.
 
 Package: stlink-tools
-Section: libdevel
 Architecture: any
-Depends: libstlink (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
-Description: OpenSource ST-Link tools replacement. Commandline Utilities.
+Depends: libstlink1 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
+Breaks: libstlink
+Replaces: libstlink
+Description: OpenSource ST-Link tools replacement.
+ Flashing tools for STMicroelectronics STM32VL and STM32L. The transport layers
+ STLINKv1 and STLINKv2 are supported.
+ .
+ This package contains commandline utilities for stlink, and modprobe and
+ udev rules.
 
 Package: stlink-gui
-Section: libdevel
 Architecture: any
-Depends: libstlink (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
-Description: OpenSource ST-Link tools replacement. GUI Tool.
+Depends: libstlink1 (= ${binary:Version}), stlink-tools (= ${binary:Version}),
+ ${shlibs:Depends}, ${misc:Depends}
+Description: OpenSource ST-Link tools replacement.
+ Flashing tools for STMicroelectronics STM32VL and STM32L. The transport layers
+ STLINKv1 and STLINKv2 are supported.
+ .
+ This package contains a GUI tool for stlink.

debian/copyright

@@ -1,12 +1,174 @@
-Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: libstlink
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: stlink
 Upstream-Contact: Andrew 'Necromant' Andrianov <[email protected]>
 Source: https://github.com/texane/stlink
 
 Files: *
-Copyright: (c) 2011 The stlink project (github.com/texane/stlink) contributors.
+Copyright: 2011-2018 agpanarin <[email protected]>
+           2011-2018 Alexey Cherevatenko <[email protected]>
+           2011-2018 Anatoli <[email protected]>
+           2011-2018 Andrea Mucignat <[email protected]>
+           2011-2018 Andrew 'Necromant' Andrianov <[email protected]>
+           2011-2018 Andrey Yurovsky <[email protected]>
+           2011-2018 Andy Isaacson <[email protected]>
+           2011-2018 Áron RADICS <[email protected]>
+           2011-2018 A Sheaff <[email protected]>
+           2011-2018 Björn Hauffe <[email protected]>
+           2011-2018 bob <[email protected]>
+           2011-2018 Breton M. Saunders <[email protected]>
+           2011-2018 Bruno Dal Bo <[email protected]>
+           2011-2018 Burns <[email protected]>
+           2011-2018 Chris Dew <[email protected]>
+           2011-2018 Chris Hiszpanski <[email protected]>
+           2011-2018 Chris Li <[email protected]>
+           2011-2018 Chris Samuelson <[email protected]>
+           2011-2018 Christophe Levantis <[email protected]>
+           2011-2018 Craig Lilley <[email protected]>
+           2011-2018 dandev37 <[email protected]>
+           2011-2018 Dan Hepler <[email protected]>
+           2011-2018 Daniel Campoverde [alx741] <[email protected]>
+           2011-2018 Daniel O'Connor <[email protected]>
+           2011-2018 Dave Flogeras <[email protected]>
+           2011-2018 Dave Murphy <[email protected]>
+           2011-2018 Dave Vandervies <[email protected]>
+           2011-2018 Denis Fokin <[email protected]>
+           2011-2018 Denis Osterland <[email protected]>
+           2011-2018 Dmitry Bravikov <[email protected]>
+           2011-2018 Efe Can İçöz <efe@debian>
+           2011-2018 Ethan Zonca <[email protected]>
+           2011-2018 Fabien Chouteau <[email protected]>
+           2011-2018 Fabien Le Mentec <[email protected]>
+           2011-2018 fhars <[email protected]>
+           2011-2018 Friedrich Beckmann <[email protected]>
+           2011-2018 Geoffrey Brown <[email protected]>
+           2011-2018 George Talusan <[email protected]>
+           2011-2018 Georg von Zengen <[email protected]>
+           2011-2018 giuseppe barba <[email protected]>
+           2011-2018 Greg Alexander <[email protected]>
+           2011-2018 Greg Meiste <[email protected]>
+           2011-2018 Hakkavélin <[email protected]>
+           2011-2018 htk <[email protected]>
+           2011-2018 Ian Griffiths <[email protected]>
+           2011-2018 Jack Peel <[email protected]>
+           2011-2018 Jakub Tyszkowski <[email protected]>
+           2011-2018 Jan Sarenik <[email protected]>
+           2011-2018 Jean-Luc Béchennec <[email protected]>
+           2011-2018 Jean-Marie Lemetayer <[email protected]>
+           2011-2018 Jeff Kent <[email protected]>
+           2011-2018 Jeffrey Nelson <[email protected]>
+           2011-2018 Jens Hoffmann <[email protected]>
+           2011-2018 Jerome Lambourg <[email protected]>
+           2011-2018 Jerry Jacobs <[email protected]>
+           2011-2018 Jim Paris <[email protected]>
+           2011-2018 Jiří Netolický <[email protected]>
+           2011-2018 jnosky <[email protected]>
+           2011-2018 jnosky <Jerry@CGS_Office.(none)>
+           2011-2018 JohannesTaelman <[email protected]>
+           2011-2018 Jonas Danielsson <[email protected]>
+           2011-2018 Jonas Norling <[email protected]>
+           2011-2018 Josh Bialkowski <[email protected]>
+           2011-2018 Karl Palsson <[email protected]>
+           2011-2018 kevin <[email protected]>
+           2011-2018 Kyle Manna <[email protected]>
+           2011-2018 Lari Lehtomäki <[email protected]>
+           2011-2018 le mentec fabien <[email protected]>
+           2011-2018 Martin Nowak <[email protected]>
+           2011-2018 Matteo Collina <[email protected]>
+           2011-2018 Max Chen <[email protected]>
+           2011-2018 Maxime Coquelin <[email protected]>
+           2011-2018 Maxime Vincent <[email protected]>
+           2011-2018 Michael Pratt <[email protected]>
+           2011-2018 Michael Sparmann <[email protected]>
+           2011-2018 Mike Szczys <[email protected]>
+           2011-2018 mlundinse <[email protected]>
+           2011-2018 mux <[email protected]>
+           2011-2018 Ned Konz <[email protected]>
+           2011-2018 Nic McDonald <[email protected]>
+           2011-2018 Nicolas Schodet <[email protected]>
+           2011-2018 Nikolay <[email protected]>
+           2011-2018 nullsub <[email protected]>
+           2011-2018 Olivier Croquette <[email protected]>
+           2011-2018 Olivier Gay <[email protected]>
+           2011-2018 Onno Kortmann <[email protected]>
+           2011-2018 orangeudav <[email protected]>
+           2011-2018 Pavel Kirienko <[email protected]>
+           2011-2018 Pekka Nikander <[email protected]>
+           2011-2018 Pete <[email protected]>
+           2011-2018 Peter Zotov <[email protected]>
+           2011-2018 Petteri Aimonen <[email protected]>
+           2011-2018 Piotr Haber <[email protected]>
+           2011-2018 Rene Hopf <[email protected]>
+           2011-2018 Robin Kreis <[email protected]>
+           2011-2018 Rob Spanton <[email protected]>
+           2011-2018 Rytis Karpuska <[email protected]>
+           2011-2018 Sean Simmons <[email protected]>
+           2011-2018 Sergey Alirzaev <[email protected]>
+           2011-2018 Simon Wright <[email protected]>
+           2011-2018 Stany MARCEL <[email protected]>
+           2011-2018 Stefan Misik <[email protected]>
+           2011-2018 Sven Wegener <[email protected]>
+           2011-2018 Tectu <[email protected]>
+           2011-2018 tekaikko <[email protected]>
+           2011-2018 texane <[email protected]>
+           2011-2018 Theodore A. Roth <[email protected]>
+           2011-2018 Thomas Gärtner <[email protected]>
+           2011-2018 Tobias Badertscher <[email protected]>
+           2011-2018 Tom de Boer <[email protected]>
+           2011-2018 Tristan Gingold <[email protected]>
+           2011-2018 Uli Köhler <[email protected]>
+           2011-2018 Uwe Bonnes <[email protected]>
+           2011-2018 Vadim Kaushan <[email protected]>
+           2011-2018 Vegard Storheil Eriksen <[email protected]>
+           2011-2018 Viacheslav Dobromyslov <[email protected]>
+           2011-2018 Victor Mayoral Vilches <[email protected]>
+           2011-2018 Wojciech A. Koszek <[email protected]>
+           2011-2018 Woodrow Douglass <[email protected]>
+           2011-2018 The "Capt'ns Missing Link" Authors.
 License: BSD-3-clause
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ .
+ * Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+ * 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.
+ * Neither the name of Intel Corporation nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "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
+ OWNER 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.
 
-Files: *
-Copyright: (c) 2011 The "Capt'ns Missing Link" Authors. All rights reserved.
-License: BSD-3-clause
+Files: flashloaders/stm32l0x.s
+       flashloaders/stm32lx.s
+Copyright: 2010 Spencer Oliver <[email protected]>
+           2011 Øyvind Harboe <[email protected]>
+           2011 Clement Burin des Roziers <[email protected]>
+License: GPL-2+
+ This package is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+ .
+ This package is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+ .
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>
+ .
+ On Debian systems, the complete text of the GNU General
+ Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".

debian/gbp.conf

@@ -0,0 +1,7 @@
+[buildpackage]
+upstream-tag = %(version)s
+debian-branch = debian
+
+[dch]
+git-log = --first-parent
+customizations = /usr/share/doc/git-buildpackage/examples/wrap_cl.py

debian/libstlink1.install

@@ -0,0 +1 @@
+usr/lib/*/lib*.so.*