summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorAndreas Rumpf <andreas@andreas-desktop>2009-11-26 00:32:07 +0100
committerAndreas Rumpf <andreas@andreas-desktop>2009-11-26 00:32:07 +0100
commit196ef92c86d8b8971d4b316f7c18e404842c4b9b (patch)
tree03506a36422f8ae7543b492978067263beea8502 /doc
parent3710309d39f65718ab5990d53a977acb241432a9 (diff)
downloadNim-196ef92c86d8b8971d4b316f7c18e404842c4b9b.tar.gz
bug concerning constant evaluation fixed
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/intern.txt7
-rwxr-xr-xdoc/manual.txt8
-rwxr-xr-xdoc/nimrodc.txt47
3 files changed, 31 insertions, 31 deletions
diff --git a/doc/intern.txt b/doc/intern.txt
index e62378e1d..dfdc33ae9 100755
--- a/doc/intern.txt
+++ b/doc/intern.txt
@@ -29,12 +29,11 @@ Path           Purpose
                version
 ``data``       data files that are used for generating source
                code
-``doc``        the documentation lives here; it is a bunch of
+``doc``        the documentation; it is a bunch of
                reStructuredText files
 ``dist``       additional packages for the distribution
 ``config``     configuration files for Nimrod
-``lib``        the Nimrod library lives here; ``rod`` depends
-               on it!
+``lib``        the Nimrod library; ``rod`` depends on it!
 ``web``        website of Nimrod; generated by ``koch.py``
                from the ``*.txt`` and ``*.tmpl`` files
 ``obj``        generated ``*.obj`` files
@@ -183,7 +182,7 @@ I use the term *cell* here to refer to everything that is traced
 This section describes how the new GC works.
 
 The basic algorithm is *Deferrent Reference Counting* with cycle detection.
-References in the stack are not counted for better performance and easier C
+References on the stack are not counted for better performance and easier C
 code generation.
 
 Each cell has a header consisting of a RC and a pointer to its type
diff --git a/doc/manual.txt b/doc/manual.txt
index 647ce2774..5b04a3b52 100755
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -666,7 +666,7 @@ The notation ``x[i]`` can be used to access the i-th element of ``x``.
 
 Arrays are always bounds checked (at compile-time or at runtime). These
 checks can be disabled via pragmas or invoking the compiler with the
-``--bound_checks:off`` command line switch.
+``--boundChecks:off`` command line switch.
 
 An open array is  also a means to implement passing a variable number of
 arguments to a procedure. The compiler converts the list of arguments
@@ -2450,11 +2450,11 @@ pragma           allowed values   description
 ===============  ===============  ============================================
 checks           on|off           Turns the code generation for all runtime
                                   checks on or off.
-bound_checks     on|off           Turns the code generation for array bound
+boundChecks      on|off           Turns the code generation for array bound
                                   checks on or off.
-overflow_checks  on|off           Turns the code generation for over- or
+overflowChecks   on|off           Turns the code generation for over- or
                                   underflow checks on or off.
-nil_checks       on|off           Turns the code generation for nil pointer
+nilChecks        on|off           Turns the code generation for nil pointer
                                   checks on or off.
 assertions       on|off           Turns the code generation for assertions
                                   on or off.
diff --git a/doc/nimrodc.txt b/doc/nimrodc.txt
index 88ca52939..3720fc5cb 100755
--- a/doc/nimrodc.txt
+++ b/doc/nimrodc.txt
@@ -12,7 +12,7 @@ Introduction
 
 This document describes the usage of the *Nimrod compiler*
 on the different supported platforms. It is not a definition of the Nimrod
-programming language (therefore is the manual).
+programming language (therefore is the `manual <manual>`_).
 
 Nimrod is free software; it is licensed under the
 `GNU General Public License <gpl.html>`_.
@@ -42,7 +42,7 @@ looks for it in the following directories (in this order):
 3. ``/etc/nimrod.cfg`` (UNIX)
 
 The search stops as soon as a configuration file has been found. The reading
-of ``nimrod.cfg`` can be suppressed by the ``--skip_cfg`` command line option.
+of ``nimrod.cfg`` can be suppressed by the ``--skipCfg`` command line option.
 Configuration settings can be overwritten in a project specific
 configuration file that is read automatically. This specific file has to
 be in the same directory as the project and be of the same name, except
@@ -125,24 +125,24 @@ At runtime the dynamic library is searched for (in this order)::
   libtcl8.3.so.0
 
 
-No_decl Pragma
-~~~~~~~~~~~~~~
-The `no_decl`:idx: pragma can be applied to almost any symbol (variable, proc,
+NoDecl Pragma
+~~~~~~~~~~~~~
+The `noDecl`:idx: pragma can be applied to almost any symbol (variable, proc,
 type, etc.) and is sometimes useful for interoperability with C:
 It tells Nimrod that it should not generate a declaration for the symbol in
 the C code. For example:
 
 .. code-block:: Nimrod
   var
-    EACCES {.importc, no_decl.}: cint # pretend EACCES was a variable, as
-                                      # Nimrod does not know its value
+    EACCES {.importc, noDecl.}: cint # pretend EACCES was a variable, as
+                                     # Nimrod does not know its value
 
 However, the ``header`` pragma is often the better alternative.
 
 
 Header Pragma
 ~~~~~~~~~~~~~
-The `header`:idx: pragma is very similar to the ``no_decl`` pragma: It can be
+The `header`:idx: pragma is very similar to the ``noDecl`` pragma: It can be
 applied to almost any symbol and specifies that it should not be declared 
 and instead the generated code should contain an ``#include``:
 
@@ -170,22 +170,23 @@ strings automatically:
   printf("hallo %s", "world") # "world" will be passed as C string
 
 
-Line_dir Option
-~~~~~~~~~~~~~~~
-The `line_dir`:idx: option can be turned on or off. If on the generated C code
-contains ``#line`` directives. This may be helpful for debugging with GDB.
+LineDir Option
+~~~~~~~~~~~~~~
+The `lineDir`:idx: option can be turned on or off. If turned on the 
+generated C code contains ``#line`` directives. This may be helpful for 
+debugging with GDB.
 
 
-Stack_trace Option
-~~~~~~~~~~~~~~~~~~
-If the `stack_trace`:idx: option is turned on, the generated C contains code to
+StackTrace Option
+~~~~~~~~~~~~~~~~~
+If the `stackTrace`:idx: option is turned on, the generated C contains code to
 ensure that proper stack traces are given if the program crashes or an
 uncaught exception is raised.
 
 
-Line_trace Option
-~~~~~~~~~~~~~~~~~
-The `line_trace`:idx: option implies the ``stack_trace`` option. If turned on,
+LineTrace Option
+~~~~~~~~~~~~~~~~
+The `lineTrace`:idx: option implies the ``stackTrace`` option. If turned on,
 the generated C contains code to ensure that proper stack traces with line
 number information are given if the program crashes or an uncaught exception
 is raised.
@@ -239,21 +240,21 @@ information that this cannot happen to the GC. If the programmer uses the
 memory, but nothing worse happens.
 
 
-Dead_code_elim Pragma
+DeadCodeElim Pragma
 ~~~~~~~~~~~~~~~~~~~~~
-The `dead_code_elim`:idx: pragma only applies to whole modules: It tells the
+The `deadCodeElim`:idx: pragma only applies to whole modules: It tells the
 compiler to activate (or deactivate) dead code elimination for the module the
 pragma appers in.
 
-The ``--dead_code_elim:on`` command line switch has the same effect as marking
-every module with ``{.dead_code_elim:on}``. However, for some modules such as
+The ``--deadCodeElim:on`` command line switch has the same effect as marking
+every module with ``{.deadCodeElim:on}``. However, for some modules such as
 the GTK wrapper it makes sense to *always* turn on dead code elimination -
 no matter if it is globally active or not.
 
 Example:
 
 .. code-block:: nimrod
-  {.dead_code_elim: on.}
+  {.deadCodeElim: on.}
 
 
 Disabling certain messages