summary refs log tree commit diff stats
path: root/lib/system
diff options
context:
space:
mode:
authorRaynei <therealqueenuk2@gmail.com>2023-04-21 09:37:21 -0400
committerGitHub <noreply@github.com>2023-04-21 15:37:21 +0200
commit48de0d0cf47131bd7e096418563463b80d43994d (patch)
treededbd19a975640e9c4955909ce83521050a79bde /lib/system
parentb54b03d04fc19d18e079ee759730298e2ecd63fd (diff)
downloadNim-48de0d0cf47131bd7e096418563463b80d43994d.tar.gz
Documented path substitution by compiler (#21662)
Document compiler path substitution (nim-lang#19928)
Diffstat (limited to 'lib/system')
-rw-r--r--lib/system/nimscript.nim1
1 files changed, 1 insertions, 0 deletions
diff --git a/lib/system/nimscript.nim b/lib/system/nimscript.nim
index 0b49ea2e7..9ce475e5b 100644
--- a/lib/system/nimscript.nim
+++ b/lib/system/nimscript.nim
@@ -86,6 +86,7 @@ proc patchFile*(package, filename, replacement: string) =
   ## is interpreted to be local to the Nimscript file that contains
   ## the call to `patchFile`, Nim's `--path` is not used at all
   ## to resolve the filename!
+  ## The compiler also performs `path substitution <nimc.html#compiler-usage-commandminusline-switches>`_ on `replacement`.
   ##
   ## Example:
   ##