GNU bug report logs - #42516
[PATCH] doc: Extend tlp-service-type example.

Previous Next

Package: guix-patches;

Reported by: Tobias Geerinckx-Rice <me <at> tobias.gr>

Date: Fri, 24 Jul 2020 10:44:02 UTC

Severity: normal

Tags: patch

Done: Tobias Geerinckx-Rice <me <at> tobias.gr>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 42516 in the body.
You can then email your comments to 42516 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Fri, 24 Jul 2020 10:44:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Tobias Geerinckx-Rice <me <at> tobias.gr>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Fri, 24 Jul 2020 10:44:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: guix-patches <at> gnu.org
Subject: [PATCH] doc: Extend tlp-service-type example.
Date: Fri, 24 Jul 2020 12:43:07 +0200
* doc/guix.texi (Power Management Services): Demonstrate
tlp-configuration usage.

Suggested by rovanion on #guix.
---
 doc/guix.texi | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index fb1c66dcf4..56085865fa 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -23490,17 +23490,17 @@ source is detected.  More information can be found at
 @uref{https://linrunner.de/en/tlp/tlp.html, TLP home page}.
 
 @deffn {Scheme Variable} tlp-service-type
-The service type for the TLP tool.  Its value should be a valid
-TLP configuration (see below).  To use the default settings, simply
-write:
+The service type for the TLP tool.  The default settings are optimised
+for battery life on most systems, but you can tweak them to your heart's
+content by passing a valid @code{tlp-configuration} as its value:
 @lisp
-(service tlp-service-type)
+(service tlp-service-type
+         (tlp-configuration
+          (cpu-scaling-governor-on-ac (list "performance"))
+          (sched-powersave-on-bat? #t)))
 @end lisp
 @end deffn
 
-By default TLP does not need much configuration but most TLP parameters
-can be tweaked using @code{tlp-configuration}.
-
 Each parameter definition is preceded by its type; for example,
 @samp{boolean foo} indicates that the @code{foo} parameter
 should be specified as a boolean.  Types starting with
-- 
2.27.0





Information forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Fri, 24 Jul 2020 22:56:02 GMT) Full text and rfc822 format available.

Message #8 received at 42516 <at> debbugs.gnu.org (full text, mbox):

From: Brett Gilio <brettg <at> gnu.org>
To: Tobias Geerinckx-Rice <me <at> tobias.gr>
Cc: 42516 <at> debbugs.gnu.org
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Fri, 24 Jul 2020 17:55:47 -0500
Tobias Geerinckx-Rice <me <at> tobias.gr> writes:

>  @deffn {Scheme Variable} tlp-service-type
> -The service type for the TLP tool.  Its value should be a valid
> -TLP configuration (see below).  To use the default settings, simply
> -write:
> +The service type for the TLP tool.  The default settings are optimised
> +for battery life on most systems, but you can tweak them to your heart's
> +content by passing a valid @code{tlp-configuration} as its value:
>  @lisp
> -(service tlp-service-type)
> +(service tlp-service-type
> +         (tlp-configuration
> +          (cpu-scaling-governor-on-ac (list "performance"))
> +          (sched-powersave-on-bat? #t)))
>  @end lisp
>  @end deffn
>  
> -By default TLP does not need much configuration but most TLP parameters
> -can be tweaked using @code{tlp-configuration}.
> -
>  Each parameter definition is preceded by its type; for example,
>  @samp{boolean foo} indicates that the @code{foo} parameter
>  should be specified as a boolean.  Types starting with

I would replace "as its value:" with "to the service type:", so it reads
"... but you can tweak them to your heart's content by passing a valid
tlp-configuration to the service type:"

Otherwise, it looks great to me!

Brett Gilio




Information forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Sat, 25 Jul 2020 17:22:02 GMT) Full text and rfc822 format available.

Message #11 received at 42516 <at> debbugs.gnu.org (full text, mbox):

From: Marius Bakke <marius <at> gnu.org>
To: Brett Gilio <brettg <at> gnu.org>, Tobias Geerinckx-Rice <me <at> tobias.gr>
Cc: 42516 <at> debbugs.gnu.org
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Sat, 25 Jul 2020 19:21:10 +0200
[Message part 1 (text/plain, inline)]
Brett Gilio <brettg <at> gnu.org> writes:

> Tobias Geerinckx-Rice <me <at> tobias.gr> writes:
>
>>  @deffn {Scheme Variable} tlp-service-type
>> -The service type for the TLP tool.  Its value should be a valid
>> -TLP configuration (see below).  To use the default settings, simply
>> -write:
>> +The service type for the TLP tool.  The default settings are optimised
>> +for battery life on most systems, but you can tweak them to your heart's
>> +content by passing a valid @code{tlp-configuration} as its value:
>>  @lisp
>> -(service tlp-service-type)
>> +(service tlp-service-type
>> +         (tlp-configuration
>> +          (cpu-scaling-governor-on-ac (list "performance"))
>> +          (sched-powersave-on-bat? #t)))
>>  @end lisp
>>  @end deffn
>>  
>> -By default TLP does not need much configuration but most TLP parameters
>> -can be tweaked using @code{tlp-configuration}.
>> -
>>  Each parameter definition is preceded by its type; for example,
>>  @samp{boolean foo} indicates that the @code{foo} parameter
>>  should be specified as a boolean.  Types starting with
>
> I would replace "as its value:" with "to the service type:", so it reads
> "... but you can tweak them to your heart's content by passing a valid
> tlp-configuration to the service type:"

Something about "tweak to your heart's content" rubs me the wrong way,
though I can't really explain why.  It feels like the manual is
passive-aggressively mocking me for trying to understand how to
configure the thing.  But that's probably just me.  :-)
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Sat, 25 Jul 2020 18:46:02 GMT) Full text and rfc822 format available.

Message #14 received at 42516 <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Brett Gilio <brettg <at> gnu.org>
Cc: 42516 <at> debbugs.gnu.org
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Sat, 25 Jul 2020 20:45:43 +0200
[Message part 1 (text/plain, inline)]
Brett,

Brett Gilio 写道:
>> -The service type for the TLP tool.  Its value should be a 
>> valid
>> -TLP configuration (see below).  To use the default settings, 
>> simply
>> -write:
>> +The service type for the TLP tool.  The default settings are 
>> optimised
>> +for battery life on most systems, but you can tweak them to 
>> your heart's
>> +content by passing a valid @code{tlp-configuration} as its 
>> value:

[…]

> I would replace "as its value:" with "to the service type:", so 
> it reads
> "... but you can tweak them to your heart's content by passing a 
> valid
> tlp-configuration to the service type:"

Ding.  You picked up on the same niggle that bugged me — both in 
the original & here.  I thought I'd just stared at it for too 
long.

‘Value’ is a reference to the terminology used in (gnu services). 
‘To the service type’ sounds less accurate.  I find the sentence 
close to clunky is it is; what about a short and sweet:

+The service type for the TLP tool.  The default settings are 
optimised
+for battery life on most systems, but you can tweak them to your 
heart's
+content by adding a valid @code{tlp-configuration}:
           ^^^^^^

Now I've definitely stared at this for too long.  How typical for 
a prose patch :-)

> Otherwise, it looks great to me!

Thanks,

T G-R
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Sat, 25 Jul 2020 19:55:02 GMT) Full text and rfc822 format available.

Message #17 received at 42516 <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Marius Bakke <marius <at> gnu.org>
Cc: 42516 <at> debbugs.gnu.org, Brett Gilio <brettg <at> gnu.org>
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Sat, 25 Jul 2020 21:54:23 +0200
[Message part 1 (text/plain, inline)]
Marius Bakke 写道:
> passive-aggressively mocking me

Wow.

Kind regards,

T G-R
[signature.asc (application/pgp-signature, inline)]

Information forwarded to guix-patches <at> gnu.org:
bug#42516; Package guix-patches. (Sat, 25 Jul 2020 21:01:02 GMT) Full text and rfc822 format available.

Message #20 received at 42516 <at> debbugs.gnu.org (full text, mbox):

From: Marius Bakke <marius <at> gnu.org>
To: Tobias Geerinckx-Rice <me <at> tobias.gr>
Cc: 42516 <at> debbugs.gnu.org, Brett Gilio <brettg <at> gnu.org>
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Sat, 25 Jul 2020 23:00:08 +0200
[Message part 1 (text/plain, inline)]
Tobias Geerinckx-Rice <me <at> tobias.gr> writes:

> Marius Bakke 写道:
>> passive-aggressively mocking me
>
> Wow.

I know, right.  It does not make any sense.  So LGTM rationally...
[signature.asc (application/pgp-signature, inline)]

Reply sent to Tobias Geerinckx-Rice <me <at> tobias.gr>:
You have taken responsibility. (Wed, 29 Jul 2020 13:24:01 GMT) Full text and rfc822 format available.

Notification sent to Tobias Geerinckx-Rice <me <at> tobias.gr>:
bug acknowledged by developer. (Wed, 29 Jul 2020 13:24:02 GMT) Full text and rfc822 format available.

Message #25 received at 42516-done <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: Marius Bakke <marius <at> gnu.org>
Cc: Brett Gilio <brettg <at> gnu.org>, 42516-done <at> debbugs.gnu.org
Subject: Re: [bug#42516] [PATCH] doc: Extend tlp-service-type example.
Date: Wed, 29 Jul 2020 15:23:49 +0200
[Message part 1 (text/plain, inline)]
Marius Bakke 写道:
> Tobias Geerinckx-Rice <me <at> tobias.gr> writes:
>> Wow.
>
> I know, right.  It does not make any sense.  So LGTM 
> rationally...

I was so #attacked.  Pushed as 
cdc2e2bba959ec3afa7de6f9a867c862982e079a.

Thank you Brett & Marius!

T G-R
[signature.asc (application/pgp-signature, inline)]

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Thu, 27 Aug 2020 11:24:04 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 214 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.