Re: Review request: debconf templates for mrtg
Eriberto Mota wrote:
> I would like to ask for a revision of the mrtg templates[1] because I am not
> a native English speaker.
Okay - commented diff below, uncommented version attached.
--- mrtg.templates.orig 2023-07-13 13:01:05.083477432 +0100
+++ mrtg.templates 2023-07-13 13:49:21.496517825 +0100
@@ -2,43 +2,40 @@
Type: boolean
Default: true
_Description: Move /etc/mrtg.cfg to /etc/mrtg/mrtg.cfg?
- Older versions of the MRTG on Debian had the /etc/mrtg.cfg configuration
- file. Currently, this file is located in /etc/mrtg/ directory, but there
- is a /etc/mrtg.cfg.
+ Older versions of MRTG on Debian had the configuration file /etc/mrtg.cfg.
+ This file should now be located in the directory /etc/mrtg/.
* I'm standardising on "MRTG" rather than "The MRTG" (even though the
expansion does have a definite article).
* recurring minor tweak: if you're mentioning an unfamiliar thing and
giving its name (rather than introducing it via a familiar
name), the name tends to come second.
* when we're halfway through installing stuff, "currently" is
ambiguous, so make it clear this is the "target" state.
* I've taken out the whole part about finding a file /etc/mrtg.conf,
since it sounds as if it's saying the install process has
tripped over a surprising misplaced file. But this is a file
that used to be provided by the package, and the short
description makes it clear that you're asking permission to
move it.
Template: mrtg/fix_permissions
Type: boolean
Default: true
_Description: Fix owner, group and permissions for /var/www/html/mrtg?
(If I was being pedantic about DLE "house style" I'd add another
comma, but it doesn't matter - these are good short descriptions.)
- By default MRTG writes all graphics in /var/www/html/mrtg/ directory. This
- directory is present at this moment, but it is insecure. Is needed to make
- this directory owned by 'mrtg' user and 'www-data' group. The recommended
- permission is 0750.
+ By default MRTG writes all graphs in the directory /var/www/html/mrtg/. This
+ directory currently exists, but it is insecure. The directory should be
+ owned by the user 'mrtg' user and group 'www-data', with recommended
+ permissions of 0750.
* graphS and graphICS are two different things.
* You're doing your cleft constructions wrong; this would be "it is
necessary to", but in fact it's easier to just reorganise it all.
Template: mrtg/create_www
Type: boolean
Default: true
_Description: Create /var/www/html/mrtg?
- By default MRTG writes all graphics in /var/www/html/mrtg/ directory. However,
- at this moment, this directory doesn't exist. Is also needed to make this
- directory owned by 'mrtg' user and 'www-data' group. The recommended
- permission is 0750.
+ By default MRTG writes all graph in the directory /var/www/html/mrtg/.
+ However, this directory doesn't currently exist. The directory should be
+ owned by the user 'mrtg' user and group 'www-data', with recommended
+ permissions of 0750.
Parallel to the above.
.
- Alternatively, you can use another path for generated graphics. Note that
+ Alternatively, you can use another path for generated graphs. Note that
keeping this directory empty when using another path is not a problem.
Template: mrtg/remove_cron
Type: boolean
Default: true
_Description: Remove old and conflicting file /etc/cron.d/mrtg?
- MRTG no longer needs to use cron because it is starting on Debian via
- systemd/init.d scripts.
+ MRTG no longer needs to use cron because it is started via systemd
+ (or init.d scripts).
.
* "systemd/init.d scripts" makes it sound as if there are systemd
scripts. In fact it might make more sense to skip all these
details and just say "because it now runs as a daemon".
- Was found a file called /etc/cron.d/mrtg, that was installed from an old
- version of the MRTG. If kept, this file will make a duplicate work because
- MRTG now runs as a daemon, coordinated by systemd/init.d. Consequently, is
- strongly recommended to remove the cron file.
+ A file /etc/cron.d/mrtg exists, left behind by an old version of MRTG.
+ If kept, this file will cause duplicate work because MRTG now runs as a
+ daemon. It is therefore strongly recommended to remove the cron file.
Reworded throughout, and it seemed pointless to explain that system
daemons are managed by the initsystem.
.
- If this cron job is needed, consider to rename the file /etc/cron.d/mrtg
- (e.g. from /etc/cron.d/mrtg to /etc/cron.d/mrtg-custom) to avoid future
- warnings.
+ If this cron job is needed, consider renaming the file (e.g. from
+ /etc/cron.d/mrtg to /etc/cron.d/mrtg-custom) to avoid future warnings.
Eliminating a redundant repetition of the filename.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- mrtg.templates.orig 2023-07-13 13:01:05.083477432 +0100
+++ mrtg.templates 2023-07-13 13:49:21.496517825 +0100
@@ -2,43 +2,40 @@
Type: boolean
Default: true
_Description: Move /etc/mrtg.cfg to /etc/mrtg/mrtg.cfg?
- Older versions of the MRTG on Debian had the /etc/mrtg.cfg configuration
- file. Currently, this file is located in /etc/mrtg/ directory, but there
- is a /etc/mrtg.cfg.
+ Older versions of MRTG on Debian had the configuration file /etc/mrtg.cfg.
+ This file should now be located in the directory /etc/mrtg/.
Template: mrtg/fix_permissions
Type: boolean
Default: true
_Description: Fix owner, group and permissions for /var/www/html/mrtg?
- By default MRTG writes all graphics in /var/www/html/mrtg/ directory. This
- directory is present at this moment, but it is insecure. Is needed to make
- this directory owned by 'mrtg' user and 'www-data' group. The recommended
- permission is 0750.
+ By default MRTG writes all graphs in the directory /var/www/html/mrtg/. This
+ directory currently exists, but it is insecure. The directory should be
+ owned by the user 'mrtg' user and group 'www-data', with recommended
+ permissions of 0750.
Template: mrtg/create_www
Type: boolean
Default: true
_Description: Create /var/www/html/mrtg?
- By default MRTG writes all graphics in /var/www/html/mrtg/ directory. However,
- at this moment, this directory doesn't exist. Is also needed to make this
- directory owned by 'mrtg' user and 'www-data' group. The recommended
- permission is 0750.
+ By default MRTG writes all graph in the directory /var/www/html/mrtg/.
+ However, this directory doesn't currently exist. The directory should be
+ owned by the user 'mrtg' user and group 'www-data', with recommended
+ permissions of 0750.
.
- Alternatively, you can use another path for generated graphics. Note that
+ Alternatively, you can use another path for generated graphs. Note that
keeping this directory empty when using another path is not a problem.
Template: mrtg/remove_cron
Type: boolean
Default: true
_Description: Remove old and conflicting file /etc/cron.d/mrtg?
- MRTG no longer needs to use cron because it is starting on Debian via
- systemd/init.d scripts.
+ MRTG no longer needs to use cron because it is started via systemd
+ (or init.d scripts).
.
- Was found a file called /etc/cron.d/mrtg, that was installed from an old
- version of the MRTG. If kept, this file will make a duplicate work because
- MRTG now runs as a daemon, coordinated by systemd/init.d. Consequently, is
- strongly recommended to remove the cron file.
+ A file /etc/cron.d/mrtg exists, left behind by an old version of MRTG.
+ If kept, this file will cause duplicate work because MRTG now runs as a
+ daemon. It is therefore strongly recommended to remove the cron file.
.
- If this cron job is needed, consider to rename the file /etc/cron.d/mrtg
- (e.g. from /etc/cron.d/mrtg to /etc/cron.d/mrtg-custom) to avoid future
- warnings.
+ If this cron job is needed, consider renaming the file (e.g. from
+ /etc/cron.d/mrtg to /etc/cron.d/mrtg-custom) to avoid future warnings.
Reply to: