* [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory @ 2022-05-13 21:43 Ludovic Courtès 2022-05-13 21:46 ` [bug#55404] [PATCH 1/2] services: Add more description fields Ludovic Courtès 2022-05-18 4:43 ` [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Maxim Cournoyer 0 siblings, 2 replies; 5+ messages in thread From: Ludovic Courtès @ 2022-05-13 21:43 UTC (permalink / raw) To: 55404; +Cc: Ludovic Courtès Hi! This change makes the ‘description’ field of <service-type> mandatory. I think it’s necessary if we are to make ‘guix system search’, ‘guix home search’, and similar tools useful. Objections? Thanks, Ludo’. Ludovic Courtès (2): services: Add more description fields. services: Make <service-type> 'description' field mandatory. gnu/services.scm | 6 +++--- gnu/services/base.scm | 3 ++- gnu/system/install.scm | 6 ++++-- gnu/tests.scm | 7 +++++-- 4 files changed, 14 insertions(+), 8 deletions(-) base-commit: 2e6f4220cffc72f55f5390a57499e95fc9a03796 -- 2.36.0 ^ permalink raw reply [flat|nested] 5+ messages in thread
* [bug#55404] [PATCH 1/2] services: Add more description fields. 2022-05-13 21:43 [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Ludovic Courtès @ 2022-05-13 21:46 ` Ludovic Courtès 2022-05-13 21:46 ` [bug#55404] [PATCH 2/2] services: Make <service-type> 'description' field mandatory Ludovic Courtès 2022-05-18 4:43 ` [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Maxim Cournoyer 1 sibling, 1 reply; 5+ messages in thread From: Ludovic Courtès @ 2022-05-13 21:46 UTC (permalink / raw) To: 55404; +Cc: Ludovic Courtès * gnu/services.scm (simple-service): Add 'description' field. * gnu/services/base.scm (udev-rules-service): Likewise. * gnu/system/install.scm (configuration-template-service-type): Likewise. * gnu/tests.scm (marionette-service-type): Likewise. --- gnu/services.scm | 3 ++- gnu/services/base.scm | 3 ++- gnu/system/install.scm | 6 ++++-- gnu/tests.scm | 7 +++++-- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/gnu/services.scm b/gnu/services.scm index e3d4fcc232..234ee372b8 100644 --- a/gnu/services.scm +++ b/gnu/services.scm @@ -292,7 +292,8 @@ (define (simple-service name target value) singleton service type NAME, of which the returned service is an instance." (let* ((extension (service-extension target identity)) (type (service-type (name name) - (extensions (list extension))))) + (extensions (list extension)) + (description "This is a simple service.")))) (service type value))) (define-syntax %modify-service diff --git a/gnu/services/base.scm b/gnu/services/base.scm index bcec888587..3fb92e6da0 100644 --- a/gnu/services/base.scm +++ b/gnu/services/base.scm @@ -2191,7 +2191,8 @@ (define* (udev-rules-service name rules #:key (groups '())) (service-extension account-service-type account-extension) (service-extension - udev-service-type udev-extension)))))) + udev-service-type udev-extension))) + (description "This service adds udev rules.")))) (service type #f))) (define (swap-space->shepherd-service-name space) diff --git a/gnu/system/install.scm b/gnu/system/install.scm index 073d7df1db..2fbf08f676 100644 --- a/gnu/system/install.scm +++ b/gnu/system/install.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2014-2022 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2015 Mark H Weaver <mhw@netris.org> ;;; Copyright © 2016 Andreas Enge <andreas@enge.fr> ;;; Copyright © 2017 Marius Bakke <mbakke@fastmail.com> @@ -252,7 +252,9 @@ (define configuration-template-service-type (service-type (name 'configuration-template) (extensions (list (service-extension etc-service-type - /etc/configuration-files))))) + /etc/configuration-files))) + (description "Install the operating system configuration file +templates under @file{/etc/configuration}."))) (define %configuration-template-service (service configuration-template-service-type #t)) diff --git a/gnu/tests.scm b/gnu/tests.scm index 85f38ae8c9..ca677d315b 100644 --- a/gnu/tests.scm +++ b/gnu/tests.scm @@ -1,5 +1,5 @@ ;;; GNU Guix --- Functional package management for GNU -;;; Copyright © 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org> +;;; Copyright © 2016-2020, 2022 Ludovic Courtès <ludo@gnu.org> ;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com> ;;; Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr> ;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be> @@ -161,7 +161,10 @@ (define marionette-service-type (service-type (name 'marionette-repl) (extensions (list (service-extension shepherd-root-service-type - marionette-shepherd-service))))) + marionette-shepherd-service))) + (description "The @dfn{marionette} service allows a guest +system (virtual machine) to be manipulated by the host. It is used for system +tests."))) (define* (marionette-operating-system os #:key -- 2.36.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* [bug#55404] [PATCH 2/2] services: Make <service-type> 'description' field mandatory. 2022-05-13 21:46 ` [bug#55404] [PATCH 1/2] services: Add more description fields Ludovic Courtès @ 2022-05-13 21:46 ` Ludovic Courtès 0 siblings, 0 replies; 5+ messages in thread From: Ludovic Courtès @ 2022-05-13 21:46 UTC (permalink / raw) To: 55404; +Cc: Ludovic Courtès * gnu/services.scm (<service-type>)[description]: Remove default value. --- gnu/services.scm | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/gnu/services.scm b/gnu/services.scm index 234ee372b8..6f0f4d5bdc 100644 --- a/gnu/services.scm +++ b/gnu/services.scm @@ -183,8 +183,7 @@ (define-record-type* <service-type> service-type make-service-type (default &no-default-value)) ;; Meta-data. - (description service-type-description ;string - (default #f)) + (description service-type-description) ;string (location service-type-location ;<location> (default (and=> (current-source-location) source-properties->location)) -- 2.36.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory 2022-05-13 21:43 [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Ludovic Courtès 2022-05-13 21:46 ` [bug#55404] [PATCH 1/2] services: Add more description fields Ludovic Courtès @ 2022-05-18 4:43 ` Maxim Cournoyer 2022-05-18 20:37 ` bug#55404: " Ludovic Courtès 1 sibling, 1 reply; 5+ messages in thread From: Maxim Cournoyer @ 2022-05-18 4:43 UTC (permalink / raw) To: Ludovic Courtès; +Cc: 55404 Hello Ludovic, Ludovic Courtès <ludo@gnu.org> writes: > Hi! > > This change makes the ‘description’ field of <service-type> mandatory. > I think it’s necessary if we are to make ‘guix system search’, ‘guix > home search’, and similar tools useful. > > Objections? None. Go for it! (LGTM) Maxim ^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#55404: [PATCH 0/2] Make 'description' of <service-type> mandatory 2022-05-18 4:43 ` [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Maxim Cournoyer @ 2022-05-18 20:37 ` Ludovic Courtès 0 siblings, 0 replies; 5+ messages in thread From: Ludovic Courtès @ 2022-05-18 20:37 UTC (permalink / raw) To: Maxim Cournoyer; +Cc: 55404-done Hello, Maxim Cournoyer <maxim.cournoyer@gmail.com> skribis: > Ludovic Courtès <ludo@gnu.org> writes: > >> Hi! >> >> This change makes the ‘description’ field of <service-type> mandatory. >> I think it’s necessary if we are to make ‘guix system search’, ‘guix >> home search’, and similar tools useful. >> >> Objections? > > None. Go for it! Alright, pushed as 3948ac25b1dccc40c7fdf56377f94a0775a835ee with additional ‘tests/services.scm’ changes I had forgotten. Thanks for taking a look! Ludo’. ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2022-05-18 20:39 UTC | newest] Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2022-05-13 21:43 [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Ludovic Courtès 2022-05-13 21:46 ` [bug#55404] [PATCH 1/2] services: Add more description fields Ludovic Courtès 2022-05-13 21:46 ` [bug#55404] [PATCH 2/2] services: Make <service-type> 'description' field mandatory Ludovic Courtès 2022-05-18 4:43 ` [bug#55404] [PATCH 0/2] Make 'description' of <service-type> mandatory Maxim Cournoyer 2022-05-18 20:37 ` bug#55404: " Ludovic Courtès
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/guix.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).