jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #627 from Varriount/internal-documentation/add-debug-info

Browse source 
Internal documentation/add debug info
This commit is contained in:
Andreas Rumpf 2013-10-27 11:13:49 -07:00
commit b51858159a
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/intern.txt
View file

@ -52,6 +52,11 @@ For a release version use::
nimrod c koch.nim nimrod c koch.nim
./koch boot -d:release ./koch boot -d:release
And for a debug version compatible with GDB::
nimrod c koch.nim
./koch boot --debuginfo --linedir:on
The ``koch`` program is Nimrod's maintenance script. It is a replacement for The ``koch`` program is Nimrod's maintenance script. It is a replacement for
make and shell scripting with the advantage that it is much more portable. make and shell scripting with the advantage that it is much more portable.
@ -64,7 +69,7 @@ Coding Guidelines
* Max line length is 80 characters. * Max line length is 80 characters.
* Provide spaces around binary operators if that enhances readability. * Provide spaces around binary operators if that enhances readability.
* Use a space after a colon, but not before it. * Use a space after a colon, but not before it.
* Start types with a capital ``T``, unless they are pointers which start * Start types with a capital ``T``, unless they are pointers/references which start
with ``P``. with ``P``.

11
doc/manual.txt
View file

@ -893,11 +893,12 @@ integers from 0 to ``len(A)-1``. An array expression may be constructed by the
array constructor ``[]``. array constructor ``[]``.
`Sequences`:idx: are similar to arrays but of dynamic length which may change `Sequences`:idx: are similar to arrays but of dynamic length which may change
during runtime (like strings). A sequence ``S`` is always indexed by integers during runtime (like strings). Sequences are implemented as growable arrays,
from 0 to ``len(S)-1`` and its bounds are checked. Sequences can be allocating pieces of memory as items are added. A sequence ``S`` is always
constructed by the array constructor ``[]`` in conjunction with the array to indexed by integers from 0 to ``len(S)-1`` and its bounds are checked.
sequence operator ``@``. Another way to allocate space for a sequence is to Sequences can be constructed by the array constructor ``[]`` in conjunction
call the built-in ``newSeq`` procedure. with the array to sequence operator ``@``. Another way to allocate space for a
sequence is to call the built-in ``newSeq`` procedure.
A sequence may be passed to a parameter that is of type *open array*. A sequence may be passed to a parameter that is of type *open array*.