[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://phonon/{phonon-backend-null.templates}



(My patch goes along with the request to revert to Type: note.)

Christian PERRIER wrote:
> +_Description: Missing backend for Phonon

The spelling "backend" is developerese - the standard English spelling
is "back end" (and it's not that dictionaries are lagging behind
normal usage; see e.g. "http://en.wikipedia.org/wiki/Back_end";).  But
since I've already seen how hard it is to get developers to accept
this I'll suggest the compromise form "back-end" within English text. 

> + Phonon-based (i.e. most KDE and some Qt) applications will produce no audio or
> + video output because there is no real Phonon backend installed on this system.
>   Typically, this is an undesirable configuration which you might have gotten to
>   unintentionally.

This use of "-based" is a potentially confusing shorthand - things
like KTorrent aren't derivatives of Phonon, they just depend on it.
Maybe we could simplify the syntax a bit and say:

    Applications using Phonon (the Qt multimedia framework for KDE) will produce
    no audio or video output because there is no real Phonon back-end installed
    on this system. This is typically an unintended configuration.

>   .
> + If you wish to restore full Phonon multimedia capabilities, you
> + should install a real Phonon backend. The following Phonon
> + backend packages seem to be available for this system at the moment:

As long as we can trust the detection (what does this depend on?) we
could rely on the colon to imply most of this:

    To restore full Phonon multimedia capabilities, install one of the Phonon
    back-end packages which are currently available for this system:
       
(This turns "install" back into an imperative, but with the preceding
purpose clause it's advisory rather than a command.)

The package descriptions have really good boilerplate already, so my
corrections are mostly very fiddly:

>  Package: phonon
[...]
> + This metapackage ensures that a user has a working Phonon configuration
>   installed on the system (the core library and at least one backend).

Package installations work per-computer, not per-user.

    This metapackage ensures that the system has a working Phonon configuration
    installed (the core library and at least one back-end).

>  Package: libphonon-dev
[...]
>   This package contains the development files needed to build Qt 4 applications
>   using Phonon cross-platform multimedia framework.
         ^the

>  Package: libphononexperimental-dev
[...]
> +Description: Phonon-Experimental multimedia framework - development files

Or should these packages be 
   Description: Phonon multimedia framework - experimental library development files
...and so on?  But that's not in my patch.

>   This package contains the development files needed to build Phonon backends or
> + internal applications which need the Phonon-Experimental library. Third-party
>   applications should not depend on this library. Please read README.Debian if
>   you consider to Build-Depend on this package.

That should be "if you are considering Build-Depending on...", or just "if
you are considering a build-dependency on...".

>  Package: libphononexperimental4
[...]
>  This package contains the Phonon-Experimental library which might be needed by
                                                        ^,
>  Phonon backends or other internal applications. Third-party applications
>  should not depend on this library. Please read README.Debian before using this
>  library.
> 
> Package: phonon-backend-null
[...]
>  This package does not provide any real Phonon backend. It can be used to
>  disable Phonon audio/video capabilities. Please note that Phonon behaviour
>  with this package installed has not been well tested.

s/behaviour/behavior/
 
> Package: phonon-dbg
[...]
>  This package contains debugging symbols of the Phonon library and main
>  backends You should install this package when you are about to report a crash
>  or want to debug a problem with Phonon or its backends.

   This package contains debugging symbols for the Phonon library and its main
   back-ends. Install it if you want to report a crash or debug a problem with
   Phonon or its back-ends.

* * *
Obligatory Why-The-Name Appendix: http://phonon.kde.org/cms/1020
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
Template: phonon-backend-null/isnt_functional_title
Type: title
_Description: Warning: Phonon is not functional

Template: phonon-backend-null/isnt_functional
Type: note
#flag:comment:4
# Translators: do not translate variable names
# only translate "(recommended)" (the one in parenthesis)
_Description: Missing backend for Phonon
 Applications using Phonon (the Qt multimedia framework for KDE) will produce
 no audio or video output because there is no real Phonon back-end installed
 on this system. This is typically an unintended configuration.
 .
 To restore full Phonon multimedia capabilities, install one of the Phonon
 back-end packages which are currently available for this system:
 .
 ${recommended_backend} (recommended)${other_backends}
Source: phonon
Section: sound
Priority: optional
Maintainer: Debian Qt/KDE Maintainers <debian-qt-kde@lists.debian.org>
Uploaders: Modestas Vainius <modax@debian.org>, Fathi Boudra <fabo@debian.org>
Build-Depends: cdbs (>= 0.4.51), debhelper (>= 7.4.13), cmake (>= 2.6.2),
 pkg-kde-tools (>= 0.11), dpkg-dev (>= 1.15.5), automoc, libglib2.0-dev,
 libpulse-dev (>= 0.9.21), libqt4-dev (>= 4.5)
Standards-Version: 3.9.1
Homepage: http://phonon.kde.org/
Vcs-Browser: http://git.debian.org/?p=pkg-kde/kde-req/phonon.git
Vcs-Git: git://git.debian.org/pkg-kde/kde-req/phonon.git

Package: phonon
Architecture: all
Depends: ${misc:Depends}, libphonon4 (>= ${source:Version}),
 ${phonon:Recommended-Backend} | phonon-backend
Suggests: ${phonon:Recommended-Backend}, phonon-backend-gstreamer,
 phonon-backend-xine, phonon-backend-mplayer
Description: Phonon multimedia framework - metapackage
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This metapackage ensures that the system has a working Phonon configuration
 installed (the core library and at least one back-end).

Package: libphonon-dev
Architecture: any
Section: libdevel
Depends: ${misc:Depends}, libphonon4 (= ${binary:Version}),
 ${sameVersionDep:libqt4-dev:libphonon4}, phonon-backend-null | phonon
Description: Phonon multimedia framework - development files
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package contains the development files needed to build Qt 4 applications
 using the Phonon cross-platform multimedia framework.

Package: libphonon4
Architecture: any
Section: libs
Depends: ${shlibs:Depends}, ${misc:Depends}
Breaks: phonon-backend-xine (<< 4:4.6.0really4.3.80)
Description: Phonon multimedia framework - core library
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package contains the core library of the Phonon cross-platform multimedia
 framework for Qt 4. It is required to run applications that use Phonon.

Package: libphononexperimental-dev
Architecture: any
Section: libdevel
Depends: ${misc:Depends}, libphononexperimental4 (= ${binary:Version}),
 ${sameVersionDep:libqt4-dev:libphononexperimental4}
Replaces: libphonon-dev (<< 4:4.6.0really4.4.4)
Breaks: libphonon-dev (<< 4:4.6.0really4.4.4)
Description: Phonon-Experimental multimedia framework - development files
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package contains the development files needed to build Phonon back-ends
 or internal applications which need the Phonon-Experimental library.
 Third-party applications should not depend on this library. Please read
 README.Debian if you are considering a build-dependency on this package.

Package: libphononexperimental4
Architecture: any
Section: libs
Depends: ${shlibs:Depends}, ${misc:Depends}
Replaces: libphonon4 (<< 4:4.6.0really4.3.80)
Breaks: libphonon4 (<< 4:4.6.0really4.3.80)
Description: Phonon-Experimental multimedia framework - library (internal)
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package contains the Phonon-Experimental library, which might be needed
 by Phonon back-ends or other internal applications. Third-party applications
 should not depend on this library. Please read README.Debian before using this
 library.

Package: phonon-backend-null
Architecture: all
Provides: phonon-backend
Depends: libphonon4, ${misc:Depends}
Conflicts: phonon-backend
Description: Phonon multimedia framework - null back-end (no real back-end)
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package does not provide any real Phonon back-end. It can be used to
 disable Phonon audio/video capabilities. Please note that Phonon behavior
 with this package installed has not been well tested.

Package: phonon-dbg
Priority: extra
Architecture: any
Section: debug
Depends: ${misc:Depends}, libphonon4 (= ${binary:Version})
Suggests: libphononexperimental4 (= ${binary:Version})
Description: Phonon multimedia framework - debugging symbols
 Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
 layer for capturing, mixing, processing, and playing audio and video content.
 .
 This package contains debugging symbols for the Phonon library and its main
 back-ends. Install it if you want to report a crash or debug a problem with
 Phonon or its back-ends.
diff -ru old/control new/control
--- old/control	2011-03-18 22:49:36.861265371 +0000
+++ new/control	2011-03-22 11:54:13.841259099 +0000
@@ -17,36 +17,36 @@
  ${phonon:Recommended-Backend} | phonon-backend
 Suggests: ${phonon:Recommended-Backend}, phonon-backend-gstreamer,
  phonon-backend-xine, phonon-backend-mplayer
-Description: metapackage for the Phonon multimedia framework
+Description: Phonon multimedia framework - metapackage
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
- This metapackage ensures that a user has working Phonon configuration
- installed on the system (the core library and at least one backend).
+ This metapackage ensures that the system has a working Phonon configuration
+ installed (the core library and at least one back-end).
 
 Package: libphonon-dev
 Architecture: any
 Section: libdevel
 Depends: ${misc:Depends}, libphonon4 (= ${binary:Version}),
  ${sameVersionDep:libqt4-dev:libphonon4}, phonon-backend-null | phonon
-Description: development files for the Phonon multimedia framework
+Description: Phonon multimedia framework - development files
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
  This package contains the development files needed to build Qt 4 applications
- using Phonon cross-platform multimedia framework.
+ using the Phonon cross-platform multimedia framework.
 
 Package: libphonon4
 Architecture: any
 Section: libs
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Breaks: phonon-backend-xine (<< 4:4.6.0really4.3.80)
-Description: the core library of the Phonon multimedia framework
+Description: Phonon multimedia framework - core library
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
  This package contains the core library of the Phonon cross-platform multimedia
- framework for Qt 4.  It is required to run applications that use Phonon.
+ framework for Qt 4. It is required to run applications that use Phonon.
 
 Package: libphononexperimental-dev
 Architecture: any
@@ -55,14 +55,14 @@
  ${sameVersionDep:libqt4-dev:libphononexperimental4}
 Replaces: libphonon-dev (<< 4:4.6.0really4.4.4)
 Breaks: libphonon-dev (<< 4:4.6.0really4.4.4)
-Description: development files for the Phonon-Experimental library
+Description: Phonon-Experimental multimedia framework - development files
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
- This package contains the development files needed to build Phonon backends or
- internal applications which need the Phonon-Experimental library. Third party
- applications should not depend on this library. Please read README.Debian if
- you consider to Build-Depend on this package.
+ This package contains the development files needed to build Phonon back-ends
+ or internal applications which need the Phonon-Experimental library.
+ Third-party applications should not depend on this library. Please read
+ README.Debian if you are considering a build-dependency on this package.
 
 Package: libphononexperimental4
 Architecture: any
@@ -70,12 +70,12 @@
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Replaces: libphonon4 (<< 4:4.6.0really4.3.80)
 Breaks: libphonon4 (<< 4:4.6.0really4.3.80)
-Description: the Phonon Experimental library (internal)
+Description: Phonon-Experimental multimedia framework - library (internal)
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
- This package contains the Phonon-Experimental library which might be needed by
- Phonon backends or other internal applications. Third party applications
+ This package contains the Phonon-Experimental library, which might be needed
+ by Phonon back-ends or other internal applications. Third-party applications
  should not depend on this library. Please read README.Debian before using this
  library.
 
@@ -84,12 +84,12 @@
 Provides: phonon-backend
 Depends: libphonon4, ${misc:Depends}
 Conflicts: phonon-backend
-Description: Phonon null backend (no real backend)
+Description: Phonon multimedia framework - null back-end (no real back-end)
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
- This package does not provide any real Phonon backend. It can be used to
- disable Phonon audio/video capabilities. Please note that Phonon behaviour 
+ This package does not provide any real Phonon back-end. It can be used to
+ disable Phonon audio/video capabilities. Please note that Phonon behavior
  with this package installed has not been well tested.
 
 Package: phonon-dbg
@@ -98,10 +98,10 @@
 Section: debug
 Depends: ${misc:Depends}, libphonon4 (= ${binary:Version})
 Suggests: libphononexperimental4 (= ${binary:Version})
-Description: Phonon debugging symbols
+Description: Phonon multimedia framework - debugging symbols
  Phonon is the Qt 4 multimedia API, which provides a task-oriented abstraction
  layer for capturing, mixing, processing, and playing audio and video content.
  .
- This package contains debugging symbols of the Phonon library and main
- backends You should install this package when you are about to report a crash
- or want to debug a problem with Phonon or its backends.
+ This package contains debugging symbols for the Phonon library and its main
+ back-ends. Install it if you want to report a crash or debug a problem with
+ Phonon or its back-ends.
diff -ru old/phonon-backend-null.templates new/phonon-backend-null.templates
--- old/phonon-backend-null.templates	2011-03-18 22:49:35.305258868 +0000
+++ new/phonon-backend-null.templates	2011-03-22 11:48:54.929259085 +0000
@@ -4,14 +4,15 @@
 
 Template: phonon-backend-null/isnt_functional
 Type: note
-_Description: Phonon multimedia capabilities are disabled
- Phonon based (i.e. most KDE and some Qt) applications will produce no audio or
- video output because there is no real Phonon backend installed on your system.
- Typically, this is an undesirable configuration which you might have gotten to
- unintentionally.
+#flag:comment:4
+# Translators: do not translate variable names
+# only translate "(recommended)" (the one in parenthesis)
+_Description: Missing backend for Phonon
+ Applications using Phonon (the Qt multimedia framework for KDE) will produce
+ no audio or video output because there is no real Phonon back-end installed
+ on this system. This is typically an unintended configuration.
  .
- If you wish to restore full Phonon multimedia capabilities, install a real
- Phonon backend with your favourite package manager. The following Phonon
- backend packages seem to be available for your system at the moment:
+ To restore full Phonon multimedia capabilities, install one of the Phonon
+ back-end packages which are currently available for this system:
  .
  ${recommended_backend} (recommended)${other_backends}

Reply to: