Merge branch 'docs' into 'main'

feedback-themes: Improve wording

See merge request Librem5/feedbackd!114

.gitignore

@@ -9,6 +9,7 @@ debian/*.debhelper.log
 debian/*.substvars
 debian/feedbackd/
 debian/feedbackd-common/
+debian/gir1.2-lfb-0.0/
 debian/libfeedback-0.0-0.substvars
 debian/libfeedback-0.0-0/
 debian/libfeedback-dev.substvars

NEWS

@@ -2,6 +2,8 @@ feedback 0.2.1
 --------------
 Released August 2023
 * Minor documentation updates
+* Contributors:
+    * Guido Günther
 
 feedback 0.2.0
 --------------

debian/control

@@ -4,21 +4,21 @@ Priority: optional
 Maintainer: Guido Günther <agx@sigxcpu.org>
 Build-Depends:
  dbus,
- debhelper-compat (= 12),
+ debhelper-compat (= 13),
  dh-sequence-gir,
  gsettings-desktop-schemas <!nocheck>,
  gi-docgen <!nodoc>,
  json-glib-tools,
  libgirepository1.0-dev,
  libglib2.0-dev,
- libgudev-1.0-dev (>= 232),
+ libgudev-1.0-dev,
  libgsound-dev,
  libjson-glib-dev,
  meson,
  pkg-config,
  python3-docutils <!nodoc>,
  valac,
-Standards-Version: 4.4.0
+Standards-Version: 4.6.2
 Homepage: https://source.puri.sm/Librem5/feedbackd
 
 Package: feedbackd
@@ -28,6 +28,8 @@ Depends:
  ${shlibs:Depends},
  feedbackd-common (>= ${source:Version}),
  sound-theme-freedesktop,
+Recommends:
+ gsettings-desktop-schemas,
 Description: DBus service for haptic/visual/audio feedback
  Feedbackd is a DBus activated daemon that provides haptic/
  visual/audio feedback based on events.
@@ -51,10 +53,12 @@ Description: Shared files for feedbackd
 
 Package: libfeedback-0.0-0
 Architecture: any
+Multi-Arch: same
 Section: libs
 Depends:
  ${misc:Depends},
  ${shlibs:Depends},
+Recommends: feedbackd (>= ${binary:Version})
 Description: Library for managing haptic/visual/audio feedback
  Feedbackd is a DBus activated daemon that provides haptic/
  visual/audio feedback based on events.
@@ -64,6 +68,7 @@ Description: Library for managing haptic/visual/audio feedback
 
 Package: libfeedback-dev
 Architecture: any
+Multi-Arch: same
 Section: libdevel
 Depends:
  gir1.2-lfb-0.0 (= ${binary:Version}),
@@ -80,6 +85,7 @@ Description: Development files for libfeedback
 
 Package: gir1.2-lfb-0.0
 Architecture: any
+Multi-Arch: same
 Section: introspection
 Depends:
  ${gir:Depends},

debian/copyright

@@ -1,9 +1,26 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: feedbackd
+Upstream-Contact: Guido Günther <agx@debian.org>
 Source: https://source.puri.sm/Librem5/feedbackd
 
 Files: *
 Copyright: 2020 Purism SPC
+License: GPL-3+
+
+Files: debian/*
+Copyright:
+ 2020 Purism SPC
+ 2020 Arnaud Ferraris <arnaud.ferraris@gmail.com>
+License: GPL-3+
+
+Files: debian/feedbackd.udev
+Copyright: 2020 Purism SPC
+License: LGPL-2.1+
+
+Files: libfeedback/*
+Copyright: 2020 Purism SPC
+License: LGPL-2.1+
+
 License: GPL-3+
  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
@@ -21,8 +38,6 @@ License: GPL-3+
  On Debian systems, the complete text of the GNU General
  Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
 
-Files: libfeedback/*
-Copyright: 2020 Purism SPC
 License: LGPL-2.1+
  This package is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by

debian/feedbackd.install

@@ -2,4 +2,3 @@
 /usr/libexec/
 /usr/share/dbus-1/
 /usr/share/feedbackd/
-/usr/share/man/

debian/feedbackd.lintian-overrides

@@ -0,0 +1 @@
+feedbackd: appstream-metadata-missing-modalias-provide lib/udev/rules.d/90-feedbackd.rules

debian/feedbackd.manpages

@@ -0,0 +1,4 @@
+/usr/share/man/man1/fbcli.1
+/usr/share/man/man1/fbd-theme-validate.1
+/usr/share/man/man5/feedback-themes.5
+/usr/share/man/man8/feedbackd.8

debian/libfeedback-0.0-0.symbols

@@ -1,4 +1,5 @@
 libfeedback-0.0.so.0 libfeedback-0.0-0 #MINVER#
+* Build-Depends-Package: libfeedback-dev
  LIBFEEDBACK_0_0_0@LIBFEEDBACK_0_0_0 0.1.1
  lfb_event_end_feedback@LIBFEEDBACK_0_0_0 0.1.1
  lfb_event_end_feedback_async@LIBFEEDBACK_0_0_0 0.1.1

debian/libfeedback-dev.doc-base

@@ -0,0 +1,12 @@
+Document: libfeedback
+Title: libfeedback Reference Manual
+Author: Guido Günther
+Abstract: A library to trigger feedback (such as haptic feedback)
+ from your application. This document covers the C API,
+ but it also useful for GObject introspection bindings
+ of your favourite programming language.
+Section: Programming
+
+Format: HTML
+Index: /usr/share/doc/libfeedback-dev/libfeedback-0/index.html
+Files: /usr/share/doc/libfeedback-dev/libfeedback-0/*.html

debian/libfeedback-dev.docs

@@ -0,0 +1 @@
+usr/share/doc/libfeedback-dev/libfeedback-0/

debian/libfeedback-dev.install

@@ -1,6 +1,5 @@
 /usr/include
 /usr/share/gir-1.0/
-/usr/share/doc/libfeedback-0 /usr/share/doc/libfeedback-dev/
 /usr/share/vala/
 /usr/lib/*/libfeedback-*.so
 /usr/lib/*/pkgconfig/libfeedback-*.pc

debian/libfeedback-dev.lintian-overrides

@@ -0,0 +1 @@
+libfeedback-dev: privacy-breach-facebook

debian/rules

@@ -10,9 +10,21 @@ ifeq (,$(filter nodoc,$(DEB_BUILD_PROFILES)))
   CONFIGURE_OPTS += -Dgtk_doc=true -Dman=true
 endif
 
+COMMON_PKG=feedbackd-common
+
+docroot := $(CURDIR)/debian/tmp/usr/share/doc/
+
 %:
 	dh $@ --builddirectory=_build
 
+override_dh_installdocs:
+	dh_installdocs -p$(COMMON_PKG) NEWS
+ifeq ($(filter nodoc,$(DEB_BUILD_PROFILES)),)
+	mkdir -p $(docroot)/libfeedback-dev/libfeedback-0
+	mv $(docroot)/libfeedback-0 $(docroot)/libfeedback-dev/
+endif
+	dh_installdocs
+
 override_dh_auto_configure:
 	dh_auto_configure -- $(CONFIGURE_OPTS)
 

debian/tests/control

@@ -11,3 +11,8 @@ Depends:
  python3,
  python3-gi,
 Restrictions: allow-stderr, superficial
+
+Test-Command: fbd-theme-validate /usr/share/feedbackd/themes/default.json
+Depends:
+ feedbackd
+Restrictions: superficial

doc/fbd-theme-validate.rst

@@ -53,4 +53,4 @@ Validate the device theme for a OnePlus 6T:
 See also
 ========
 
-``feedbackd(8)`` ``fbcli(1)``
+``feedbackd(8)`` ``fbcli(1)`` ``feedback-themes``

doc/feedback-themes.rst

@@ -1,7 +1,7 @@
 .. _feedback-themes(5):
 
 ===============
-feedback themes
+feedback-themes
 ===============
 
 ---------------------------------
@@ -12,16 +12,15 @@ DESCRIPTION
 ===========
 
 In order to reflect device specifics and user overrides the feedback
-(such as sound, haptic or led) that are being triggered by events can
+(such as sound, haptic or led) that is being triggered by an event can
-be configured. This allows for device as well as user specific
+be configured and overridden by so called themes. Feedback themes use a JSON
-configuration. Themes use a json format and can be validated by
+format that can be validated with ``fbd-theme-validate``.
-``fbd-theme-validate``.
 
 For details on how to create or modify feedback themes see [feedbackd's documentation](
-https://source.puri.sm/Librem5/feedbackd#feedback-theme)
+https://source.puri.sm/Librem5/feedbackd#feedback-theme).
 
-Sound events
+Sound feedback
-============
+==============
 
 Sound feedbacks specify an event name from a XDG sound theme. Sound themes
 are described in the [Sound theme spec](https://freedesktop.org/wiki/Specifications/sound-theme-spec/).

doc/feedbackd.rst

@@ -39,4 +39,4 @@ Options
 See also
 ========
 
-``fbcli(1)`` ``fbd-theme-validate(1)`` ``feedback-themes(5)`` ``feedback-themes(5)``
+``fbcli(1)`` ``fbd-theme-validate(1)`` ``feedback-themes(5)``