* [bug#55752] [PATCH 2/5] guix system: Add 'edit' sub-command.
2022-06-01 15:42 ` [bug#55752] [PATCH 1/5] edit: Extract 'spawn-editor' procedure Ludovic Courtès
@ 2022-06-01 15:42 ` Ludovic Courtès
2022-06-01 15:43 ` [bug#55752] [PATCH 3/5] home: services: Add 'lookup-home-service-types' procedure Ludovic Courtès
` (2 subsequent siblings)
3 siblings, 0 replies; 9+ messages in thread
From: Ludovic Courtès @ 2022-06-01 15:42 UTC (permalink / raw)
To: 55752; +Cc: Ludovic Courtès
* guix/scripts/system/edit.scm: New file.
* Makefile.am (MODULES): Add it.
* guix/scripts/system.scm (show-help): Mention "edit".
(actions): Add it.
(process-command): Handle it.
* doc/guix.texi (Invoking guix system): Document it.
* po/guix/POTFILES.in: Add guix/scripts/system/edit.scm.
---
Makefile.am | 3 +-
doc/guix.texi | 13 ++++++++
guix/scripts/system.scm | 7 +++-
guix/scripts/system/edit.scm | 64 ++++++++++++++++++++++++++++++++++++
po/guix/POTFILES.in | 1 +
5 files changed, 86 insertions(+), 2 deletions(-)
create mode 100644 guix/scripts/system/edit.scm
diff --git a/Makefile.am b/Makefile.am
index 968bde8131..f585d00b86 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -308,8 +308,9 @@ MODULES = \
guix/scripts/describe.scm \
guix/scripts/style.scm \
guix/scripts/system.scm \
- guix/scripts/system/search.scm \
+ guix/scripts/system/edit.scm \
guix/scripts/system/reconfigure.scm \
+ guix/scripts/system/search.scm \
guix/scripts/home.scm \
guix/scripts/home/import.scm \
guix/scripts/lint.scm \
diff --git a/doc/guix.texi b/doc/guix.texi
index 88e009fe7c..ecd99084ef 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -36617,6 +36617,19 @@ As for @command{guix package --search}, the result is written in
@code{recutils} format, which makes it easy to filter the output
(@pxref{Top, GNU recutils databases,, recutils, GNU recutils manual}).
+@cindex service type definition, editing
+@cindex editing, service type definition
+@item edit
+Edit or view the definition of the given service types.
+
+For example, the command below opens your editor, as specified by the
+@env{EDITOR} environment variable, on the definition of the
+@code{openssh} service type:
+
+@example
+guix system edit openssh
+@end example
+
@item reconfigure
Build the operating system described in @var{file}, activate it, and
switch to it@footnote{This action (and the related actions
diff --git a/guix/scripts/system.scm b/guix/scripts/system.scm
index eaa245eb44..261a1d226d 100644
--- a/guix/scripts/system.scm
+++ b/guix/scripts/system.scm
@@ -944,6 +944,8 @@ (define (show-help)
(newline)
(display (G_ "\
search search for existing service types\n"))
+ (display (G_ "\
+ edit edit the definition of an existing service type\n"))
(display (G_ "\
reconfigure switch to a new operating system configuration\n"))
(display (G_ "\
@@ -1172,7 +1174,8 @@ (define actions '("build" "container" "vm" "vm-image" "image" "disk-image"
"extension-graph" "shepherd-graph"
"list-generations" "describe"
"delete-generations" "roll-back"
- "switch-generation" "search" "docker-image"))
+ "switch-generation" "search" "edit"
+ "docker-image"))
(define (process-action action args opts)
"Process ACTION, a sub-command, with the arguments are listed in ARGS.
@@ -1340,6 +1343,8 @@ (define-syntax-rule (with-store* store exp ...)
(display-system-generation generation))))
((search)
(apply (resolve-subcommand "search") args))
+ ((edit)
+ (apply (resolve-subcommand "edit") args))
;; The following commands need to use the store, but they do not need an
;; operating system configuration file.
((delete-generations)
diff --git a/guix/scripts/system/edit.scm b/guix/scripts/system/edit.scm
new file mode 100644
index 0000000000..d966ee0aaa
--- /dev/null
+++ b/guix/scripts/system/edit.scm
@@ -0,0 +1,64 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2022 Ludovic Courtès <ludo@gnu.org>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix scripts system edit)
+ #:use-module (guix diagnostics)
+ #:use-module (guix i18n)
+ #:use-module (guix ui)
+ #:autoload (guix utils) (string-closest)
+ #:use-module (gnu services)
+ #:use-module (srfi srfi-1)
+ #:use-module (ice-9 match)
+ #:autoload (guix scripts edit) (spawn-editor)
+ #:export (guix-system-edit))
+
+(define (service-type-not-found type)
+ "Report an error about @var{type} not being found and exit."
+ (report-error (G_ "~a: no such service type~%") type)
+
+ (let* ((type (symbol->string type))
+ (available (fold-service-types (lambda (type lst)
+ (cons (symbol->string
+ (service-type-name type))
+ lst))
+ '()))
+ (closest (string-closest type available)))
+ (unless (or (not closest) (string=? closest type))
+ (display-hint (format #f (G_ "Did you mean @code{~a}?~%")
+ closest))))
+
+ (exit 1))
+
+\f
+(define (guix-system-edit . args)
+ (when (null? args)
+ (leave (G_ "no service types specified, nothing to edit~%")))
+
+ (let* ((types (append-map (lambda (type)
+ (let ((type (string->symbol type)))
+ (match (lookup-service-types type)
+ (() (service-type-not-found type))
+ ((one) (list one))
+ (lst
+ (warning (N_ "~a: ~a matching service type~%"
+ "~a: ~a matching service types~%"
+ (length lst))
+ type (length lst))
+ lst))))
+ args)))
+ (spawn-editor (filter-map service-type-location types))))
diff --git a/po/guix/POTFILES.in b/po/guix/POTFILES.in
index 49a8edfef3..5ad3c9f0a8 100644
--- a/po/guix/POTFILES.in
+++ b/po/guix/POTFILES.in
@@ -87,6 +87,7 @@ guix/scripts/pull.scm
guix/scripts/substitute.scm
guix/scripts/authenticate.scm
guix/scripts/system.scm
+guix/scripts/system/edit.scm
guix/scripts/system/search.scm
guix/scripts/lint.scm
guix/scripts/publish.scm
--
2.36.1
^ permalink raw reply related [flat|nested] 9+ messages in thread* [bug#55752] [PATCH 3/5] home: services: Add 'lookup-home-service-types' procedure.
2022-06-01 15:42 ` [bug#55752] [PATCH 1/5] edit: Extract 'spawn-editor' procedure Ludovic Courtès
2022-06-01 15:42 ` [bug#55752] [PATCH 2/5] guix system: Add 'edit' sub-command Ludovic Courtès
@ 2022-06-01 15:43 ` Ludovic Courtès
2022-06-01 15:43 ` [bug#55752] [PATCH 4/5] guix home: Add 'edit' sub-command Ludovic Courtès
2022-06-01 15:43 ` [bug#55752] [PATCH 5/5] DRAFT news: Add entry for 'guix system edit' and 'guix home edit' Ludovic Courtès
3 siblings, 0 replies; 9+ messages in thread
From: Ludovic Courtès @ 2022-06-01 15:43 UTC (permalink / raw)
To: 55752; +Cc: Ludovic Courtès
* gnu/home/services.scm (lookup-home-service-types): New procedure.
* tests/home-services.scm: New file.
* Makefile.am (SCM_TESTS): Add it.
---
Makefile.am | 1 +
gnu/home/services.scm | 12 +++++++++++
tests/home-services.scm | 46 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 59 insertions(+)
create mode 100644 tests/home-services.scm
diff --git a/Makefile.am b/Makefile.am
index f585d00b86..89bc03c9a2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -497,6 +497,7 @@ SCM_TESTS = \
tests/gremlin.scm \
tests/hackage.scm \
tests/home-import.scm \
+ tests/home-services.scm \
tests/http-client.scm \
tests/import-git.scm \
tests/import-github.scm \
diff --git a/gnu/home/services.scm b/gnu/home/services.scm
index 8284a4f3fc..5ee3357792 100644
--- a/gnu/home/services.scm
+++ b/gnu/home/services.scm
@@ -33,6 +33,7 @@ (define-module (gnu home services)
#:use-module (guix modules)
#:use-module (srfi srfi-1)
#:use-module (ice-9 match)
+ #:use-module (ice-9 vlist)
#:export (home-service-type
home-profile-service-type
@@ -50,6 +51,7 @@ (define-module (gnu home services)
xdg-data-files-directory
fold-home-service-types
+ lookup-home-service-types
home-provenance
%initialize-gettext)
@@ -605,3 +607,13 @@ (define (all-home-service-modules)
(define* (fold-home-service-types proc seed)
(fold-service-types proc seed (all-home-service-modules)))
+
+(define lookup-home-service-types
+ (let ((table
+ (delay (fold-home-service-types (lambda (type result)
+ (vhash-consq (service-type-name type)
+ type result))
+ vlist-null))))
+ (lambda (name)
+ "Return the list of services with the given NAME (a symbol)."
+ (vhash-foldq* cons '() name (force table)))))
diff --git a/tests/home-services.scm b/tests/home-services.scm
new file mode 100644
index 0000000000..e13733cabd
--- /dev/null
+++ b/tests/home-services.scm
@@ -0,0 +1,46 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2022 Ludovic Courtès <ludo@gnu.org>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (test-home-services)
+ #:use-module (gnu services)
+ #:use-module (gnu home services)
+ #:use-module (guix diagnostics)
+ #:use-module (srfi srfi-1)
+ #:use-module (srfi srfi-64)
+ #:use-module (ice-9 match))
+
+(test-begin "home-services")
+
+(test-assert "fold-home-service-types"
+ (match (fold-home-service-types cons '())
+ (() #f)
+ (lst (and (every service-type? lst)
+ (every (lambda (type)
+ (let ((location (service-type-location type)))
+ (string-contains (location-file location)
+ "gnu/home")))
+ lst)))))
+
+(test-eq "lookup-service-types"
+ home-files-service-type
+ (and (null? (lookup-home-service-types 'does-not-exist-at-all))
+ (match (lookup-home-service-types 'home-files)
+ ((one) one)
+ (x x))))
+
+(test-end)
--
2.36.1
^ permalink raw reply related [flat|nested] 9+ messages in thread* [bug#55752] [PATCH 4/5] guix home: Add 'edit' sub-command.
2022-06-01 15:42 ` [bug#55752] [PATCH 1/5] edit: Extract 'spawn-editor' procedure Ludovic Courtès
2022-06-01 15:42 ` [bug#55752] [PATCH 2/5] guix system: Add 'edit' sub-command Ludovic Courtès
2022-06-01 15:43 ` [bug#55752] [PATCH 3/5] home: services: Add 'lookup-home-service-types' procedure Ludovic Courtès
@ 2022-06-01 15:43 ` Ludovic Courtès
2022-06-01 15:43 ` [bug#55752] [PATCH 5/5] DRAFT news: Add entry for 'guix system edit' and 'guix home edit' Ludovic Courtès
3 siblings, 0 replies; 9+ messages in thread
From: Ludovic Courtès @ 2022-06-01 15:43 UTC (permalink / raw)
To: 55752; +Cc: Ludovic Courtès
* guix/scripts/home/edit.scm: New file.
* Makefile.am (MODULES): Add it.
* guix/scripts/home.scm (show-help): Add "edit".
(process-command): Handle it.
(guix-home): Add it.
* po/guix/POTFILES.in: Add 'guix/scripts/home/edit.scm'.
* doc/guix.texi (Invoking guix home): Document it.
---
Makefile.am | 1 +
doc/guix.texi | 13 ++++++++
guix/scripts/home.scm | 7 +++-
guix/scripts/home/edit.scm | 66 ++++++++++++++++++++++++++++++++++++++
po/guix/POTFILES.in | 1 +
5 files changed, 87 insertions(+), 1 deletion(-)
create mode 100644 guix/scripts/home/edit.scm
diff --git a/Makefile.am b/Makefile.am
index 89bc03c9a2..e8d4b7ef8a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -312,6 +312,7 @@ MODULES = \
guix/scripts/system/reconfigure.scm \
guix/scripts/system/search.scm \
guix/scripts/home.scm \
+ guix/scripts/home/edit.scm \
guix/scripts/home/import.scm \
guix/scripts/lint.scm \
guix/scripts/challenge.scm \
diff --git a/doc/guix.texi b/doc/guix.texi
index ecd99084ef..f85eaacdfa 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -39466,6 +39466,19 @@ guix home container config.scm -- herd status
The command to run in the container must come after @code{--} (double
hyphen).
+@cindex service type definition, editing
+@cindex editing, service type definition
+@item edit
+Edit or view the definition of the given Home service types.
+
+For example, the command below opens your editor, as specified by the
+@env{EDITOR} environment variable, on the definition of the
+@code{home-mcron} service type:
+
+@example
+guix home edit home-mcron
+@end example
+
@item reconfigure
Build the home environment described in @var{file}, and switch to it.
Switching means that the activation script will be evaluated and (in
diff --git a/guix/scripts/home.scm b/guix/scripts/home.scm
index f43bf865a7..0f5c3388a1 100644
--- a/guix/scripts/home.scm
+++ b/guix/scripts/home.scm
@@ -60,6 +60,7 @@ (define-module (guix scripts home)
#:autoload (guix scripts pull) (channel-commit-hyperlink)
#:autoload (guix scripts system) (service-node-type
shepherd-service-node-type)
+ #:autoload (guix scripts home edit) (guix-home-edit)
#:autoload (guix scripts home import) (import-manifest)
#:use-module ((guix status) #:select (with-status-verbosity))
#:use-module ((guix build utils) #:select (mkdir-p))
@@ -93,6 +94,8 @@ (define (show-help)
(newline)
(display (G_ "\
search search for existing service types\n"))
+ (display (G_ "\
+ edit edit the definition of an existing service type\n"))
(display (G_ "
container run the home environment configuration in a container\n"))
(display (G_ "\
@@ -539,6 +542,8 @@ (define-syntax-rule (with-store* store exp ...)
;; an home environment file.
((search)
(apply search args))
+ ((edit)
+ (apply guix-home-edit args))
((import)
(let* ((profiles (delete-duplicates
(match (filter-map (match-lambda
@@ -611,7 +616,7 @@ (define (parse-sub-command arg result)
extension-graph shepherd-graph
list-generations describe
delete-generations roll-back
- switch-generation search
+ switch-generation search edit
import container)
(alist-cons 'action action result))
(else (leave (G_ "~a: unknown action~%") action))))))
diff --git a/guix/scripts/home/edit.scm b/guix/scripts/home/edit.scm
new file mode 100644
index 0000000000..a6c05675b3
--- /dev/null
+++ b/guix/scripts/home/edit.scm
@@ -0,0 +1,66 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2022 Ludovic Courtès <ludo@gnu.org>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (guix scripts home edit)
+ #:use-module (guix diagnostics)
+ #:use-module (guix i18n)
+ #:use-module (guix ui)
+ #:autoload (guix utils) (string-closest)
+ #:use-module (gnu services)
+ #:use-module (gnu home services)
+ #:use-module (srfi srfi-1)
+ #:use-module (ice-9 match)
+ #:autoload (guix scripts edit) (spawn-editor)
+ #:export (guix-home-edit))
+
+(define (service-type-not-found type)
+ "Report an error about @var{type} not being found and exit."
+ (report-error (G_ "~a: no such service type~%") type)
+
+ (let* ((type (symbol->string type))
+ (available (fold-home-service-types (lambda (type lst)
+ (cons (symbol->string
+ (service-type-name type))
+ lst))
+ '()))
+ (closest (string-closest type available)))
+ (unless (or (not closest) (string=? closest type))
+ (display-hint (format #f (G_ "Did you mean @code{~a}?~%")
+ closest))))
+
+ (exit 1))
+
+\f
+(define (guix-home-edit . args)
+ (when (null? args)
+ (leave (G_ "no service types specified, nothing to edit~%")))
+
+ (with-error-handling
+ (let* ((types (append-map (lambda (type)
+ (let ((type (string->symbol type)))
+ (match (lookup-home-service-types type)
+ (() (service-type-not-found type))
+ ((one) (list one))
+ (lst
+ (warning (N_ "~a: ~a matching service type~%"
+ "~a: ~a matching service types~%"
+ (length lst))
+ type (length lst))
+ lst))))
+ args)))
+ (spawn-editor (filter-map service-type-location types)))))
diff --git a/po/guix/POTFILES.in b/po/guix/POTFILES.in
index 5ad3c9f0a8..6b8bd92bb7 100644
--- a/po/guix/POTFILES.in
+++ b/po/guix/POTFILES.in
@@ -125,6 +125,7 @@ guix/scripts/archive.scm
guix/scripts/build.scm
guix/scripts/discover.scm
guix/scripts/environment.scm
+guix/scripts/home/edit.scm
guix/scripts/home/import.scm
guix/scripts/home.scm
guix/scripts/time-machine.scm
--
2.36.1
^ permalink raw reply related [flat|nested] 9+ messages in thread* [bug#55752] [PATCH 5/5] DRAFT news: Add entry for 'guix system edit' and 'guix home edit'.
2022-06-01 15:42 ` [bug#55752] [PATCH 1/5] edit: Extract 'spawn-editor' procedure Ludovic Courtès
` (2 preceding siblings ...)
2022-06-01 15:43 ` [bug#55752] [PATCH 4/5] guix home: Add 'edit' sub-command Ludovic Courtès
@ 2022-06-01 15:43 ` Ludovic Courtès
2022-06-02 11:41 ` Maxime Devos
3 siblings, 1 reply; 9+ messages in thread
From: Ludovic Courtès @ 2022-06-01 15:43 UTC (permalink / raw)
To: 55752; +Cc: Ludovic Courtès
DRAFT: Add correct commit ID before pushing.
* etc/news.scm: Add entry.
---
etc/news.scm | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/etc/news.scm b/etc/news.scm
index a74ca94b8a..70ef607911 100644
--- a/etc/news.scm
+++ b/etc/news.scm
@@ -25,6 +25,34 @@
(channel-news
(version 0)
+ (entry (commit "XXX")
+ (title
+ (en "New @command{edit} sub-commands for services")
+ (fr "Nouvelles commandes @command{edit} pour les services"))
+ (body
+ (en "The new @command{guix system edit} and @command{guix home edit} commands
+allow you to view or edit service types defined for Guix System or Guix Home.
+For example, here is how you would open the definition of the OpenSSH system
+service:
+
+@example
+guix system edit openssh
+@end example
+
+Run @command{info \"(guix) Invoking guix system\"} or @command{info \"(guix)
+Invoking guix home\"} for more info.")
+ (fr "Les nouvelles commandes @command{guix system edit} et
+@command{guix home edit} permettent de visualiser ou d'éditer les types de
+services définis pour Guix System ou Guix Home. Par exemple, voici comment
+ouvrir la définition du service système OpenSSH :
+
+@example
+guix system edit openssh
+@end example
+
+Lancer @command{info \"(guix.fr) Invoquer guix system\"} ou @command{info
+\"(guix.fr) Invoquer guix home\"} pour plus d'informations.")))
+
(entry (commit "903c82583e1cec4c9ff09d5895c5cc646c37b661")
(title
(en "New @command{guix import elm} command")
--
2.36.1
^ permalink raw reply related [flat|nested] 9+ messages in thread