bug#37804: getmail service documentation error?

bug#37804: getmail service documentation error?

[pelzflorian (Florian Pelz)]

[-- Attachment #1: Type: text/plain, Size: 457 bytes --]

The documentation of the getmail service’s delete_after setting is
confusing and appears to contradict upstream documentation at
<http://pyropus.ca/software/getmail/configuration.html>.

I am not sure, but the code in the getmail file in the getmail source
code also appears to call destination.deliver_message before deleting,
in agreement with upstream.

Can someone with knowledge check?  Shall I push the attached patch?

Regards,
Florian

[-- Attachment #2: 0001-Fix-documentation-of-delete_after-in-the-getmail-ser.patch --]
[-- Type: text/plain, Size: 1757 bytes --]

From 971fee0af8908acdc73498917a8a55811122ac8e Mon Sep 17 00:00:00 2001
From: Florian Pelz <pelzflorian@pelzflorian.de>
Date: Fri, 18 Oct 2019 08:52:12 +0200
Subject: [PATCH] Fix documentation of delete_after in the getmail service.

* doc/guix.texi (Getmail service): Remove the word `not'.
* gnu/services/getmail.scm (getmail-options-configuration): Ditto.
---
 doc/guix.texi            | 2 +-
 gnu/services/getmail.scm | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index a38eb2aa7c..32d2ffe044 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17435,7 +17435,7 @@ Defaults to @samp{#f}.
 
 @deftypevr {@code{getmail-options-configuration} parameter} non-negative-integer delete-after
 Getmail will delete messages this number of days after seeing them, if
-they have not been delivered.  This means messages will be left on the
+they have been delivered.  This means messages will be left on the
 server this number of days after delivering them.  A value of @samp{0}
 disabled this feature.
 
diff --git a/gnu/services/getmail.scm b/gnu/services/getmail.scm
index b807bb3a5d..b3d86cb65c 100644
--- a/gnu/services/getmail.scm
+++ b/gnu/services/getmail.scm
@@ -176,8 +176,8 @@ server.")
   (delete-after
    (non-negative-integer 0)
    "Getmail will delete messages this number of days after seeing them, if
-they have not been delivered.  This means messages will be left on the server
-this number of days after delivering them.  A value of @samp{0} disabled this
+they have been delivered.  This means messages will be left on the server this
+number of days after delivering them.  A value of @samp{0} disabled this
 feature.")
   (delete-bigger-than
    (non-negative-integer 0)
-- 
2.23.0

bug#37804: getmail service documentation error?

[Christopher Baines]

[-- Attachment #1: Type: text/plain, Size: 569 bytes --]


pelzflorian (Florian Pelz) <pelzflorian@pelzflorian.de> writes:

> The documentation of the getmail service’s delete_after setting is
> confusing and appears to contradict upstream documentation at
> <http://pyropus.ca/software/getmail/configuration.html>.
>
> I am not sure, but the code in the getmail file in the getmail source
> code also appears to call destination.deliver_message before deleting,
> in agreement with upstream.
>
> Can someone with knowledge check?  Shall I push the attached patch?

The change and patch looks reasonable to me.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 962 bytes --]

bug#37804: getmail service documentation error?

[pelzflorian (Florian Pelz)]

On Fri, Oct 18, 2019 at 08:47:11AM +0100, Christopher Baines wrote:
> The change and patch looks reasonable to me.


Pushed.  Thank you!

bug#37804: getmail service documentation error?

[pelzflorian (Florian Pelz)]

On Fri, Oct 18, 2019 at 10:02:31AM +0200, pelzflorian (Florian Pelz) wrote:
> On Fri, Oct 18, 2019 at 08:47:11AM +0100, Christopher Baines wrote:
> > The change and patch looks reasonable to me.
> 
> 
> Pushed.  Thank you!
> 
> 
> 

I forgot prefixing the commit with doc.  Too late now.  Sorry.