summary refs log tree commit diff
diff options
context:
space:
mode:
authorGabriel Wicki <gabriel@erlikon.ch>2023-04-13 10:31:57 +0200
committerLudovic Courtès <ludo@gnu.org>2023-05-11 16:38:28 +0200
commit199218e372f490ae8158bac99d3a434557ef1bec (patch)
treeabec35cbb7273b17be3f45e746b35213f29a5e87
parent61031dd32fe948d927472a8ade60df6441cc6655 (diff)
downloadguix-199218e372f490ae8158bac99d3a434557ef1bec.tar.gz
doc: Clarify substitute* docstring with an example.
* doc/guix.texi (Build Utilities): Update the corresponding passage.

Co-authored-by: Ludovic Courtès <ludo@gnu.org>
-rw-r--r--doc/guix.texi4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 2871fb9957..31ebcf9db4 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10379,7 +10379,9 @@ Alternatively, @var{file} may be a list of file names, in which case
 they are all subject to the substitutions.
 
 Be careful about using @code{$} to match the end of a line; by itself it
-won't match the terminating newline of a line.
+won't match the terminating newline of a line.  For example, to match a
+whole line ending with a backslash, one needs a regex like
+@code{"(.*)\\\\\n$"}.
 @end defmac
 
 @subsection File Search