[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug#69302] [PATCH v2 2/2] doc: Add “Inspecting Services” section.
From: |
Ludovic Courtès |
Subject: |
[bug#69302] [PATCH v2 2/2] doc: Add “Inspecting Services” section. |
Date: |
Sun, 25 Feb 2024 15:48:54 +0100 |
* doc/guix.texi (Inspecting Services): New subsection.
Change-Id: I71378101de913a494e0d0e93cc76434c5a70b520
---
doc/guix.texi | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 55 insertions(+)
diff --git a/doc/guix.texi b/doc/guix.texi
index 0634d5051e..3e5514cf45 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -17536,6 +17536,61 @@ Using the Configuration System
(delete avahi-service-type))
@end lisp
+@unnumberedsubsec Inspecting Services
+
+@cindex troubleshooting, for system services
+@cindex inspecting system services
+@cindex system services, inspecting
+As you work on your system configuration, you might wonder why some
+system service doesn't show up or why the system as not as you expected.
+There are several ways to inspect and troubleshoot problems.
+
+@cindex dependency graph, of Shepherd services
+First, you can inspect the dependency graph of Shepherd services like
+so:
+
+@example
+guix system shepherd-graph /etc/config.scm | \
+ guix shell xdot -- xdot -
+@end example
+
+This lets you visualize the Shepherd services as defined in
+@file{/etc/config.scm}. Each box is a service as would be shown by
+@command{sudo herd status} on the running system, and each arrow denotes
+a dependency (in the sense that if service @var{A} depends on @var{B},
+then @var{B} must be started before @var{A}).
+
+@cindex extension graph, of services
+Not all ``services'' are Shepherd services though, since Guix System
+uses a broader definition of the term (@pxref{Services}). To visualize
+system services and their relations at a higher level, run:
+
+@example
+guix system extension-graph /etc/config.scm | \
+ guix shell xdot -- xdot -
+@end example
+
+This lets you view the @dfn{service extension graph}: how services
+``extend'' each other, for instance by contributing to their
+configuration. @xref{Service Composition}, to understand the meaning of
+this graph.
+
+Last, you may also find it useful to inspect your system configuration
+at the REPL (@pxref{Using Guix Interactively}). Here is an example
+session:
+
+@example
+$ guix repl
+scheme@@(guix-user)> ,use (gnu)
+scheme@@(guix-user)> (define os (load "config.scm"))
+scheme@@(guix-user)> ,pp (map service-kind (operating-system-services os))
+$1 = (#<service-type localed cabba93>
+ @dots{})
+@end example
+
+@xref{Service Reference}, to learn about the Scheme interface to
+manipulate and inspect services.
+
@unnumberedsubsec Instantiating the System
@cindex system instantiation
--
2.41.0
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., (continued)
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., Ludovic Courtès, 2024/02/21
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., Oleg Pykhalov, 2024/02/22
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., Ludovic Courtès, 2024/02/24
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., Oleg Pykhalov, 2024/02/24
- [bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., Ludovic Courtès, 2024/02/24
- [bug#69302] [PATCH v2 0/2] New "Getting Started" section for Guix System, Ludovic Courtès, 2024/02/25
- [bug#69302] [PATCH v2 1/2] doc: Add “Getting Started with the System” section., Ludovic Courtès, 2024/02/25
- [bug#69302] [PATCH v2 1/2] doc: Add “Getting Started with the System” section., pelzflorian (Florian Pelz), 2024/02/27
- [bug#69302] [PATCH v2 1/2] doc: Add “Getting Started with the System” section., pelzflorian (Florian Pelz), 2024/02/27
- [bug#69302] [PATCH v2 1/2] doc: Add “Getting Started with the System” section., Ludovic Courtès, 2024/02/28
- [bug#69302] [PATCH v2 2/2] doc: Add “Inspecting Services” section.,
Ludovic Courtès <=
- [bug#69302] [PATCH v2 2/2] doc: Add “Inspecting Services” section., pelzflorian (Florian Pelz), 2024/02/27
[bug#69302] [PATCH 1/2] doc: Add “Getting Started with the System” section., pelzflorian (Florian Pelz), 2024/02/22