Bug#823898: libconfig-model-systemd-perl: Minor error in package description (a spurious "OK"?)

2016-05-10 Thread Dominique Dumont 
On Tue, 10 May 2016 15:49:06 +0100 Justin B Rye  
wrote:
> Well, for a start "systemd" is canonically lowercase.  Also, this is a
> capitalised verb phrase (saying what the package does) instead of an
> uncapitalised noun phrase (saying what it is); for enhanced DevRef
> compliance you could make it:
> 
>  Description: editor and validator for systemd configuration files
> or
>  Description: systemd configuration file editor and validator

ok. I also have to fix upstream.

> #  Config::Model::Systemd provides a configuration editor for the
> #  configuration file of Systemd, i.e. all files in
> #  ~/.config/systemd/user/ or all files in /etc/systemd/system/ Ok.
> 
> This appears to be saying that systemd has only one configuration
> file, which consists of all the files in one of two places.

Good point. Fixed.

> Upstream has "Ok. I simplified".  It seems a bit pointless to phrase
> things in an oversimplified way when that just means you're going to
> have to explain it twice.  If I'm correctly understanding this, why
> not just say:
> 
>  Description: systemd configuration file editor and validator
>   Config::Model::Systemd provides configuration models for systemd
>   configuration files (that is, all files in /etc/systemd/system/ and
>   ~/.config/systemd/user/). Config::Model, Config::Model::TkUI, and cme
>   can use these models for configuration editing and validation.

I'd rather keep the 2 explanations which answer 2 different questions.

The first question is, why should a user install this package ? I hope that the
first explanation answers that in the simplest possible way.

Then other user may wonder what is the content of this package, I.e. how does 
it compare to libconfig-model-perl. Hence the 2nd explanation.

I've also forgotten to add a recommend field for cme and libconfig-model-tkui-
perl. Without these packages, libconfig-model-systemd-perl is pretty useless.

Thanks for the suggestions

All the best
-- 
 https://github.com/dod38fr/   -o- http://search.cpan.org/~ddumont/
http://ddumont.wordpress.com/  -o-   irc: dod at irc.debian.org

Bug#823898: libconfig-model-systemd-perl: Minor error in package description (a spurious "OK"?)

2016-05-10 Thread Justin B Rye 
Package: libconfig-model-systemd-perl
Followup-For: Bug #823898

> There's indeed an issue with the description. I've tried to simplify the text
> from upstream but something went wrong.

I noticed this bugreport and had a look for myself.  There are a
couple of other oddities in the description (inherited from the
upstream text):

# Description: Edit and validate Systemd configuration files

Well, for a start "systemd" is canonically lowercase.  Also, this is a
capitalised verb phrase (saying what the package does) instead of an
uncapitalised noun phrase (saying what it is); for enhanced DevRef
compliance you could make it:

 Description: editor and validator for systemd configuration files
or
 Description: systemd configuration file editor and validator
   
#  Config::Model::Systemd provides a configuration editor for the
#  configuration file of Systemd, i.e. all files in
#  ~/.config/systemd/user/ or all files in /etc/systemd/system/ Ok.

This appears to be saying that systemd has only one configuration
file, which consists of all the files in one of two places.

#  .
#  This was quite simplified. Actually, this module provides the
#  configuration models of Systemd configuration file that cme,
#  Config::Model and Config::Model::TkUI use to provide a configuration
#  editor and checker.

Upstream has "Ok. I simplified".  It seems a bit pointless to phrase
things in an oversimplified way when that just means you're going to
have to explain it twice.  If I'm correctly understanding this, why
not just say:

 Description: systemd configuration file editor and validator
  Config::Model::Systemd provides configuration models for systemd
  configuration files (that is, all files in /etc/systemd/system/ and
  ~/.config/systemd/user/). Config::Model, Config::Model::TkUI, and cme
  can use these models for configuration editing and validation.

-- 
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru libconfig-model-systemd-perl-0.005.pristine/debian/control libconfig-model-systemd-perl-0.005/debian/control
--- libconfig-model-systemd-perl-0.005.pristine/debian/control	2016-05-09 20:03:29.0 +0100
+++ libconfig-model-systemd-perl-0.005/debian/control	2016-05-10 15:41:50.346327689 +0100
@@ -25,13 +25,9 @@
  liblog-log4perl-perl,
  libmouse-perl,
  libpath-tiny-perl (>= 0.086)
-Description: Edit and validate Systemd configuration files
- Config::Model::Systemd provides a configuration editor for the
- configuration file of Systemd, i.e. all files in
- ~/.config/systemd/user/ or all files in /etc/systemd/system/ Ok.
- .
- This was quite simplified. Actually, this module provides the
- configuration models of Systemd configuration file that cme,
- Config::Model and Config::Model::TkUI use to provide a configuration
- editor and checker.
+Description: systemd configuration file editor and validator
+ Config::Model::Systemd provides configuration models for systemd
+ configuration files (that is, all files in /etc/systemd/system/ and
+ ~/.config/systemd/user/). Config::Model, Config::Model::TkUI, and cme
+ can use these models for configuration editing and validation.
 Homepage: https://metacpan.org/pod/Config::Model::Systemd

Bug#823898: libconfig-model-systemd-perl: Minor error in package description (a spurious "OK"?)

2016-05-10 Thread Dominique Dumont 
Hello Beatrice

> I hope I am not wasting your time.

Not at all. I'm glad to have feedback on all issues, especially doc issues 
(because I often don't see them :-/ ).

There's indeed an issue with the description. I've tried to simplify the text 
from upstream but something went wrong.

I'll fix this.

Thanks for the report.

All the best
-- 
 https://github.com/dod38fr/   -o- http://search.cpan.org/~ddumont/
http://ddumont.wordpress.com/  -o-   irc: dod at irc.debian.org

Bug#823898: libconfig-model-systemd-perl: Minor error in package description (a spurious "OK"?)

2016-05-10 Thread Beatrice Torracca 
Package: libconfig-model-systemd-perl
Severity: minor

Hi!

the package description currently has the first paragraph that ends
with an "OK." that loos to me (not a native speaker) out of place.

It almost looks like a copy/paste error from a language review.

I have a suspicion that also the first sentence of the second
paragraph, that is "This was quite simplified." might be
unintentionally included in the description.

I hope I am not wasting your time.

Thanks,

beatrice