summaryrefslogtreecommitdiffstats
path: root/runtime
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2019-06-15 15:45:06 +0200
committerBram Moolenaar <Bram@vim.org>2019-06-15 15:45:06 +0200
commit9937a055437ef67b57a1bdec8f0799b669c9dbf0 (patch)
tree64fee6ad078086b7714995b03cb7891641d13533 /runtime
parentdfa97f2aed3d8ca195d09e2ce91cef227f933961 (diff)
patch 8.1.1539: not easy to define a variable and lock itv8.1.1539
Problem: Not easy to define a variable and lock it. Solution: Add ":const".
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/eval.txt27
1 files changed, 25 insertions, 2 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index da45de805a..ca3f4ca065 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -11598,8 +11598,31 @@ text...
No error message is given for a non-existing
variable, also without !.
If the system does not support deleting an environment
- variable, it is made emtpy.
-
+ variable, it is made empty.
+
+ *:cons* *:const* *E996*
+:cons[t] {var-name} = {expr1}
+:cons[t] [{name1}, {name2}, ...] = {expr1}
+:cons[t] [{name1}, {name2}, ...] .= {expr1}
+:cons[t] [{name}, ..., ; {lastname}] = {expr1}
+:cons[t] {var-name} =<< [trim] {marker}
+text...
+text...
+{marker}
+ Similar to |:let|, but additionally lock the variable
+ after setting the value. This is the same as locking
+ the variable with |:lockvar| just after |:let|, thus: >
+ :const x = 1
+< is equivalent to: >
+ :let x = 1
+ :lockvar 1 x
+< This is useful if you want to make sure the variable
+ is not modified.
+ *E995*
+ |:const| does not allow to for changing a variable. >
+ :let x = 1
+ :const x = 2 " Error!
+<
:lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
Lock the internal variable {name}. Locking means that
it can no longer be changed (until it is unlocked).