Please find, for review, the debconf templates and packages descriptions for the mplayer source package. This review will last from Thursday, October 04, 2007 to Sunday, October 14, 2007. Please send reviews as unified diffs (diff -u) against the original files. Comments about your proposed changes will be appreciated. Your review should be sent as an answer to this mail. When appropriate, I will send intermediate requests for review, with "[RFRn]" (n>=2) as a subject tag. When we will reach a consensus, I send a "Last Chance For Comments" mail with "[LCFC]" as a subject tag. Finally, the reviewed templates will be sent to the package maintainer as a bug report, and a mail will be sent to this list with "[BTS]" as a subject tag. Rationale: --- mplayer.old/debian/mplayer.templates 2007-09-23 07:21:55.231717618 +0200 +++ mplayer/debian/mplayer.templates 2007-10-03 07:48:07.794377514 +0200 @@ -1,82 +1,94 @@ Template: mplayer/cfgnote Type: note -_Description: Create your ~/.mplayer/config file - Performance of MPlayer depends heavily on hardware - this means that - it may benefit from tweaking options, for every single machine it's - installed to. You may wish to read the documentation (it is in the - package 'mplayer-doc', under /usr/share/doc/mplayer-doc/). This DebConf - interface will help you setup just a few main features; you may wish to - add to /etc/mplayer/mplayer.conf some more refined options (to enable - multichannel audio, or video postprocessing, etc etc); and any user - similarly may customize MPlayer using the file ~/.mplayer/config +_Description: Detailed configuration needed for each user + The performance of MPlayer heavily depends on hardware; this means that + it may benefit from tweaking options for every single machine it's + installed to. + . + You should read the software documentation provided by the + 'mplayer-doc' package. + . + Some configuration options will now be set for the entire system in + /etc/mplayer/mplayer.conf which may be later adapted. Any user can also + refine options in ~/.mplayer/config I explained in a separate bug report why I consider this template to be debconf abuse...but let's review it anyway in case you disagree with me. I entirely rewrote it for: - use the recommended writing style for notes and therefore make the short description a "title" -improve readability by shortening it down and breaking it in paragraphs -not mention Debconf Template: mplayer/rtc Type: boolean Default: false _Description: Enable access to RTC? - On older kernels MPlayer can use the RTC (Real Time Clock) to provide - better timing in reproduction, with less CPU cost; to this end, - though, the device /dev/rtc must be accessible to group audio, and - the default max-user-freq must be raised to 1024. Any needed change - must be done by root. If you wish, MPlayer will automatically do - this at boot, so that any user can enjoy this feature. Note that - there may be security issues with this (although none are known now). + On older kernels, MPlayer can use the RTC (Real Time Clock) to provide + better timing in reproduction, with less CPU cost. + . + For this option to work, the /dev/rtc device must be readable by + the 'audio' group and the default max-user-freq must be raised to 1024 by + the superuser. + . + This can be done automatically at boot, to the expense of potential (but + limited) security implications. I wondered whether this template is still needed as I have no idea what "older kernels" mean. Split in paragraphs and use a more direct style. No need to mention that changes must be done by root as this will be handled by the main scripts Template: mplayer/replace-existing-files Type: boolean Default: false _Description: Replace existing configuration file? - There is already a file /etc/mplayer/mplayer.conf, but it does not - contain an automatically generated part. This script may generate a - new file (the old file will be moved to /etc/mplayer/mplayer.conf.debconf-old). + A /etc/mplayer/mplayer.conf file already exists on the system and + does not contain an automatically-generated part. That file can be replaced + by a generated one (the old file will be moved to + /etc/mplayer/mplayer.conf.debconf-old). Avoid "there is a file" and use a more factual wording. Avoid "this script" and just tell what is about to happen. Template: mplayer/replace-existing-files-bail Type: note -_Description: Files not replaced - It seems that you don't want to replace your existing configuration - file /etc/mplayer/mplayer.conf. If you change your mind later, you - can run "dpkg-reconfigure mplayer". +_Description: Old configuration file kept + You choosed not to replace the existing /etc/mplayer/mplayer.conf + file. + . + That file can be generated automatically later by running + 'dpkg-reconfigure mplayer'. That one is also imho debconf abuse but let's rephrase it anyway. Use a positive wording (file kept) instead of negative (files not replaced). Avoid "it seems" and "you don't want". Be factual: this template comes because the user does not want to replace files... Template: mplayer/voutput Type: select Default: autodetect Choices: ${vochoices} _Description: MPlayer video output: - MPlayer can use a very wide range of video output drivers; - it will try to autodetect the best one, but you may choose a preferred one. - Here is a guide to the choice (in decreasing order of speed): - (1) if you see an entry that matches your video card, choose that; - (2) if your video card supports 'XV', choose that (use 'xvinfo' to know). - You should read /usr/share/doc/mplayer-doc/HTML/en/video.html (it is in - package 'mplayer-doc'). + MPlayer can use a very wide range of video output drivers. + The needed driver may be detected automatically or chosen manually. + . + If you prefer choosing the driver yourself, you should first choose + an entry matching this system's video card. In case none is matching and the + card supports 'XV', choose that option (the 'xvinfo' command may help). + . + Please read the /usr/share/doc/mplayer-doc/HTML/en/video.html file from + the 'mplayer-doc' package for more details. Split in paragraphs The "here is a guide" thing is useless. That's precisely what debconf templates are for..:-) Template: mplayer/install_codecs Type: note -_Description: How to download binary codecs - MPlayer supports most codecs out of the box and the rest with the - help of binary codecs. Binary codecs are only necessary for Real 3.0 - and 4.0, Windows Media 9, QuickTime audio and some very obscure codecs. - Debian cannot distribute these codecs, but these are available on the - internet for download. Run the script - `/usr/share/mplayer/scripts/binary_codecs.sh' to install those - made available from MPlayer web site. +_Description: Binary codecs download + MPlayer supports most video formats without additional software. + . + Additional video formats, such as Real 3.0/4.0, Windows Media 9, Quicktime, + can be supported by using binary codecs. + . + As such codecs are not free software, they are not distributed with + this package but can be downloaded freely. The + '/usr/share/mplayer/scripts/binary_codecs.sh' script is provided in + this package to help downloading them from the MPlayer web site. Same remark about abuse/not abuse..:-) - Turn the short part into a title - Split in paragraphs -Do not mention "Debian" to avoid such branding to become a problem for derived distributions. Explain why they aren't distributed. Template: mplayer/dvd_device Type: string Default: /dev/cdrom _Description: DVD device name: - What is the name of your DVD device (if any): + Please enter the name of the device for your DVD player, if any. Double "prompting" should be avoided and so should the interrogative form. Template: mplayer/ttfont Type: select Choices: ${ttfontchoices} Default: ${ttfontdefault} -_Description: MPlayer OSD font: - MPlayer needs True Type fonts for On Screen Display. Choose your favorite. +_Description: Font for On Screen Display: The long part does not really add much value. Template: mplayer/no-ttfont -Type: note -_Description: MPlayer cannot find TrueType Fonts - You should install a package providing truetype fonts (such as - 'ttf-freefont' or 'ttf-bitstream-vera' or 'msttcorefonts' ) - and reconfigure MPlayer (with the command "dpkg-reconfigure mplayer") +Type: error +_Description: No TrueType fonts foudn for On Screen Display + MPlayer needs at least one TrueType font for its 'On Screen Diplay' feature. + . + You should install a package providing such fonts (such as + 'ttf-freefont' or 'ttf-bitstream-vera' or 'msttcorefonts') + and reconfigure MPlayer (by running 'dpkg-reconfigure mplayer'). Turn the note template (that one is not abuse..:-)) into an error template First explain why we display the template (MPlayer needs....), then what should be done. --- ../mplayer.old/debian/control 2007-09-23 07:21:55.231717618 +0200 +++ debian/control 2007-10-04 18:47:08.857602369 +0200 @@ -19,30 +19,27 @@ Architecture: any Suggests: mplayer-doc, ttf-freefont, netselect | fping, bzip2, fontconfig Depends: ${shlibs:Depends}, debconf-2.0 | debconf, mplayer-skin -Description: The Movie Player - MPlayer is a movie player for GNU/Linux. - . +Description: movie player for GNU/Linux MPlayer plays most MPEG, VOB, AVI, Ogg/OGM, VIVO, ASF/WMA/WMV, QT/MOV/MP4, FLI, RM, NuppelVideo, yuv4mpeg, FILM, RoQ, PVA files, - supported by many native, XAnim, RealPlayer, and Win32 DLL codecs. You can - watch VideoCD, SVCD, DVD, 3ivx, RealMedia, and DivX movies too. + supported by many native, XAnim, RealPlayer, and Win32 DLL codecs. It can + also play VideoCD, SVCD, DVD, 3ivx, RealMedia, and DivX movies too. "The" Movie Player, with capitals is a bit emphatic. There are others...:-)) use lowercase and merge te first paragraph in the short description Avoid personnalization (You can) and use more neutral wording. . Another big feature of MPlayer is the wide range of supported output - drivers. It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, + drivers. It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, Avoid double spaces after sentence periods DirectFB, but also SDL (and this way all its drivers) and some lowlevel card-specific drivers (for Matrox, 3Dfx and Radeon, Mach64, - Permedia3) Most of them supports software or hardware scaling, - so you can enjoy movies in fullscreen. MPlayer supports also - displaying through some hardware MPEG decoder boards, such as the DVB + Permedia3). Most of them support software or hardware scaling, + therefore allowing fullscreen display. MPlayer is also able + to use some hardware MPEG decoder boards, such as the DVB and DXR3/Hollywood+. Punctuation s/supports/support simpler wording to avoid "display through" . - NOTE: the .tar.gz distributed with Debian does not contain all of the upstream - code. Read README.Debian and copyright for details. + Some parts of upstream code are not distributed along with that package. + Please read the README.Debian and copyright files for details. simplify what we want to explain: just tell that parts of upstream code is not there. Package: mplayer-doc Architecture: all Recommends: mplayer Description: documentation for MPlayer - MPlayer is a movie player for GNU/Linux. - . - This package contains the documentation. + This package contains the documentation for MPlayer, a movie player for + GNU/Linux. Merge the two very small paragraphs in one. --
Template: mplayer/cfgnote Type: note _Description: Detailed configuration needed for each user The performance of MPlayer heavily depends on hardware; this means that it may benefit from tweaking options for every single machine it's installed to. . You should read the software documentation provided by the 'mplayer-doc' package. . Some configuration options will now be set for the entire system in /etc/mplayer/mplayer.conf which may be later adapted. Any user can also refine options in ~/.mplayer/config. Template: mplayer/rtc Type: boolean Default: false _Description: Enable access to RTC? On older kernels, MPlayer can use the RTC (Real Time Clock) to provide better timing in reproduction, with less CPU cost. . For this option to work, the /dev/rtc device must be readable by the 'audio' group and the default max-user-freq must be raised to 1024 by the superuser. . This can be done automatically at boot, to the expense of potential (but limited) security implications. Template: mplayer/replace-existing-files Type: boolean Default: false _Description: Replace existing configuration file? A /etc/mplayer/mplayer.conf file already exists on the system and does not contain an automatically-generated part. That file can be replaced by a generated one (the old file will be moved to /etc/mplayer/mplayer.conf.debconf-old). Template: mplayer/replace-existing-files-bail Type: note _Description: Old configuration file kept You choosed not to replace the existing /etc/mplayer/mplayer.conf file. . That file can be generated automatically later by running 'dpkg-reconfigure mplayer'. Template: mplayer/voutput Type: select Default: autodetect Choices: ${vochoices} _Description: MPlayer video output: MPlayer can use a very wide range of video output drivers. The needed driver may be detected automatically or chosen manually. . If you prefer choosing the driver yourself, you should first choose an entry matching this system's video card. In case none is matching and the card supports 'XV', choose that option (the 'xvinfo' command may help). . Please read the /usr/share/doc/mplayer-doc/HTML/en/video.html file from the 'mplayer-doc' package for more details. Template: mplayer/install_codecs Type: note _Description: Binary codecs download MPlayer supports most video formats without additional software. . Additional video formats, such as Real 3.0/4.0, Windows Media 9, Quicktime, can be supported by using binary codecs. . As such codecs are not free software, they are not distributed with this package but can be downloaded freely. The '/usr/share/mplayer/scripts/binary_codecs.sh' script is provided in this package to help downloading them from the MPlayer web site. Template: mplayer/dvd_device Type: string Default: /dev/cdrom _Description: DVD device name: Please enter the name of the device for your DVD player, if any. Template: mplayer/ttfont Type: select Choices: ${ttfontchoices} Default: ${ttfontdefault} _Description: Font for On Screen Display: Template: mplayer/no-ttfont Type: error _Description: No TrueType fonts found for On Screen Display MPlayer needs at least one TrueType font for its 'On Screen Diplay' feature. . You should install a package providing such fonts (such as 'ttf-freefont' or 'ttf-bitstream-vera' or 'msttcorefonts') and reconfigure MPlayer (by running 'dpkg-reconfigure mplayer').
--- ../mplayer.old/debian/mplayer.templates 2007-09-23 07:21:55.231717618 +0200 +++ debian/mplayer.templates 2007-10-04 18:43:05.343725304 +0200 @@ -1,82 +1,94 @@ Template: mplayer/cfgnote Type: note -_Description: Create your ~/.mplayer/config file - Performance of MPlayer depends heavily on hardware - this means that - it may benefit from tweaking options, for every single machine it's - installed to. You may wish to read the documentation (it is in the - package 'mplayer-doc', under /usr/share/doc/mplayer-doc/). This DebConf - interface will help you setup just a few main features; you may wish to - add to /etc/mplayer/mplayer.conf some more refined options (to enable - multichannel audio, or video postprocessing, etc etc); and any user - similarly may customize MPlayer using the file ~/.mplayer/config +_Description: Detailed configuration needed for each user + The performance of MPlayer heavily depends on hardware; this means that + it may benefit from tweaking options for every single machine it's + installed to. + . + You should read the software documentation provided by the + 'mplayer-doc' package. + . + Some configuration options will now be set for the entire system in + /etc/mplayer/mplayer.conf which may be later adapted. Any user can also + refine options in ~/.mplayer/config. Template: mplayer/rtc Type: boolean Default: false _Description: Enable access to RTC? - On older kernels MPlayer can use the RTC (Real Time Clock) to provide - better timing in reproduction, with less CPU cost; to this end, - though, the device /dev/rtc must be accessible to group audio, and - the default max-user-freq must be raised to 1024. Any needed change - must be done by root. If you wish, MPlayer will automatically do - this at boot, so that any user can enjoy this feature. Note that - there may be security issues with this (although none are known now). + On older kernels, MPlayer can use the RTC (Real Time Clock) to provide + better timing in reproduction, with less CPU cost. + . + For this option to work, the /dev/rtc device must be readable by + the 'audio' group and the default max-user-freq must be raised to 1024 by + the superuser. + . + This can be done automatically at boot, to the expense of potential (but + limited) security implications. Template: mplayer/replace-existing-files Type: boolean Default: false _Description: Replace existing configuration file? - There is already a file /etc/mplayer/mplayer.conf, but it does not - contain an automatically generated part. This script may generate a - new file (the old file will be moved to /etc/mplayer/mplayer.conf.debconf-old). + A /etc/mplayer/mplayer.conf file already exists on the system and + does not contain an automatically-generated part. That file can be replaced + by a generated one (the old file will be moved to + /etc/mplayer/mplayer.conf.debconf-old). Template: mplayer/replace-existing-files-bail Type: note -_Description: Files not replaced - It seems that you don't want to replace your existing configuration - file /etc/mplayer/mplayer.conf. If you change your mind later, you - can run "dpkg-reconfigure mplayer". +_Description: Old configuration file kept + You choosed not to replace the existing /etc/mplayer/mplayer.conf + file. + . + That file can be generated automatically later by running + 'dpkg-reconfigure mplayer'. Template: mplayer/voutput Type: select Default: autodetect Choices: ${vochoices} _Description: MPlayer video output: - MPlayer can use a very wide range of video output drivers; - it will try to autodetect the best one, but you may choose a preferred one. - Here is a guide to the choice (in decreasing order of speed): - (1) if you see an entry that matches your video card, choose that; - (2) if your video card supports 'XV', choose that (use 'xvinfo' to know). - You should read /usr/share/doc/mplayer-doc/HTML/en/video.html (it is in - package 'mplayer-doc'). + MPlayer can use a very wide range of video output drivers. + The needed driver may be detected automatically or chosen manually. + . + If you prefer choosing the driver yourself, you should first choose + an entry matching this system's video card. In case none is matching and the + card supports 'XV', choose that option (the 'xvinfo' command may help). + . + Please read the /usr/share/doc/mplayer-doc/HTML/en/video.html file from + the 'mplayer-doc' package for more details. Template: mplayer/install_codecs Type: note -_Description: How to download binary codecs - MPlayer supports most codecs out of the box and the rest with the - help of binary codecs. Binary codecs are only necessary for Real 3.0 - and 4.0, Windows Media 9, QuickTime audio and some very obscure codecs. - Debian cannot distribute these codecs, but these are available on the - internet for download. Run the script - `/usr/share/mplayer/scripts/binary_codecs.sh' to install those - made available from MPlayer web site. +_Description: Binary codecs download + MPlayer supports most video formats without additional software. + . + Additional video formats, such as Real 3.0/4.0, Windows Media 9, Quicktime, + can be supported by using binary codecs. + . + As such codecs are not free software, they are not distributed with + this package but can be downloaded freely. The + '/usr/share/mplayer/scripts/binary_codecs.sh' script is provided in + this package to help downloading them from the MPlayer web site. Template: mplayer/dvd_device Type: string Default: /dev/cdrom _Description: DVD device name: - What is the name of your DVD device (if any): + Please enter the name of the device for your DVD player, if any. Template: mplayer/ttfont Type: select Choices: ${ttfontchoices} Default: ${ttfontdefault} -_Description: MPlayer OSD font: - MPlayer needs True Type fonts for On Screen Display. Choose your favorite. +_Description: Font for On Screen Display: Template: mplayer/no-ttfont -Type: note -_Description: MPlayer cannot find TrueType Fonts - You should install a package providing truetype fonts (such as - 'ttf-freefont' or 'ttf-bitstream-vera' or 'msttcorefonts' ) - and reconfigure MPlayer (with the command "dpkg-reconfigure mplayer") +Type: error +_Description: No TrueType fonts found for On Screen Display + MPlayer needs at least one TrueType font for its 'On Screen Diplay' feature. + . + You should install a package providing such fonts (such as + 'ttf-freefont' or 'ttf-bitstream-vera' or 'msttcorefonts') + and reconfigure MPlayer (by running 'dpkg-reconfigure mplayer'). --- ../mplayer.old/debian/control 2007-09-23 07:21:55.231717618 +0200 +++ debian/control 2007-10-04 18:47:08.857602369 +0200 @@ -19,30 +19,27 @@ Architecture: any Suggests: mplayer-doc, ttf-freefont, netselect | fping, bzip2, fontconfig Depends: ${shlibs:Depends}, debconf-2.0 | debconf, mplayer-skin -Description: The Movie Player - MPlayer is a movie player for GNU/Linux. - . +Description: movie player for GNU/Linux MPlayer plays most MPEG, VOB, AVI, Ogg/OGM, VIVO, ASF/WMA/WMV, QT/MOV/MP4, FLI, RM, NuppelVideo, yuv4mpeg, FILM, RoQ, PVA files, - supported by many native, XAnim, RealPlayer, and Win32 DLL codecs. You can - watch VideoCD, SVCD, DVD, 3ivx, RealMedia, and DivX movies too. + supported by many native, XAnim, RealPlayer, and Win32 DLL codecs. It can + also play VideoCD, SVCD, DVD, 3ivx, RealMedia, and DivX movies too. . Another big feature of MPlayer is the wide range of supported output - drivers. It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, + drivers. It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, DirectFB, but also SDL (and this way all its drivers) and some lowlevel card-specific drivers (for Matrox, 3Dfx and Radeon, Mach64, - Permedia3) Most of them supports software or hardware scaling, - so you can enjoy movies in fullscreen. MPlayer supports also - displaying through some hardware MPEG decoder boards, such as the DVB + Permedia3). Most of them support software or hardware scaling, + therefore allowing fullscreen display. MPlayer is also able + to use some hardware MPEG decoder boards, such as the DVB and DXR3/Hollywood+. . - NOTE: the .tar.gz distributed with Debian does not contain all of the upstream - code. Read README.Debian and copyright for details. + Some parts of upstream code are not distributed along with that package. + Please read the README.Debian and copyright files for details. Package: mplayer-doc Architecture: all Recommends: mplayer Description: documentation for MPlayer - MPlayer is a movie player for GNU/Linux. - . - This package contains the documentation. + This package contains the documentation for MPlayer, a movie player for + GNU/Linux.
Source: mplayer Section: graphics Priority: optional Maintainer: A Mennucc1 <mennucc1@debian.org> Uploaders: Dariush Pietrzak <eyck@kuszelas.com> Standards-Version: 3.7.2.0 Build-Depends-Indep: Build-Depends: debhelper (>= 4), make (>= 3.80), pkg-config, po-debconf, libsdl1.2-dev | libsdl1.1-dev, svgalibg1-dev [i386], libdts-dev, ladspa-sdk, libpng-dev, libncurses5-dev, zlib1g-dev, libspeex-dev, libsmbclient-dev, libtheora-dev (>= 0.0.0.alpha3-1), libesd0-dev, liblzo-dev, libgl1-mesa-dev, libasound2-dev (>= 1.0.6-3) [!kfreebsd-i386 !kfreebsd-amd64 !hurd-i386], libvorbis-dev, liblircclient-dev, libfreetype6-dev, libdvdread3-dev, libcdparanoia0-dev, libfontconfig1-dev, libjpeg62-dev, libungif4-dev, libgtk2.0-dev, libdirectfb-dev, libcaca-dev, liblivemedia-dev, libx11-dev, libxext-dev, libxinerama-dev, libxv-dev, libxvmc-dev, libxxf86dga-dev, libxxf86vm-dev, x-dev, Package: mplayer Architecture: any Suggests: mplayer-doc, ttf-freefont, netselect | fping, bzip2, fontconfig Depends: ${shlibs:Depends}, debconf-2.0 | debconf, mplayer-skin Description: movie player for GNU/Linux MPlayer plays most MPEG, VOB, AVI, Ogg/OGM, VIVO, ASF/WMA/WMV, QT/MOV/MP4, FLI, RM, NuppelVideo, yuv4mpeg, FILM, RoQ, PVA files, supported by many native, XAnim, RealPlayer, and Win32 DLL codecs. It can also play VideoCD, SVCD, DVD, 3ivx, RealMedia, and DivX movies too. . Another big feature of MPlayer is the wide range of supported output drivers. It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, DirectFB, but also SDL (and this way all its drivers) and some lowlevel card-specific drivers (for Matrox, 3Dfx and Radeon, Mach64, Permedia3). Most of them support software or hardware scaling, therefore allowing fullscreen display. MPlayer is also able to use some hardware MPEG decoder boards, such as the DVB and DXR3/Hollywood+. . Some parts of upstream code are not distributed along with that package. Please read the README.Debian and copyright files for details. Package: mplayer-doc Architecture: all Recommends: mplayer Description: documentation for MPlayer This package contains the documentation for MPlayer, a movie player for GNU/Linux.
Attachment:
signature.asc
Description: Digital signature