follow nim-lang#8463 nim-lang#14157 and document cstring literals mod…

…ification is not allowed (nim-lang#15878) * follow nim-lang#8463 nim-lang#14157 and document cstring literals * Update doc/manual.rst Co-authored-by: Juan Carlos <[email protected]> Co-authored-by: Andreas Rumpf <[email protected]>
PMunch · Jan 6, 2021 · 37f1695 · 37f1695
1 parent e5297a8
commit 37f1695
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/doc/manual.rst b/doc/manual.rst
@@ -1280,6 +1280,20 @@ string from a cstring:
   var cstr: cstring = str
   var newstr: string = $cstr
 
+``cstring`` literals shouldn't be modified.
+
+.. code-block:: nim
+  var x = cstring"literals"
+  x[1] = 'A' # This is wrong!!!
+
+If the ``cstring`` originates from a regular memory (not read-only memory),
+it can be modified:
+
+.. code-block:: nim
+  var x = "123456"
+  var s: cstring = x
+  s[0] = 'u' # This is ok
+
 Structured types
 ----------------
 A variable of a structured type can hold multiple values at the same