tiny C support; cosmetic improvements for the docs

This commit is contained in:
Araq 2010-08-28 22:33:07 +02:00
commit 47886978c7
151 changed files with 63611 additions and 43 deletions

39
doc/advopt.txt Executable file
View file

@ -0,0 +1,39 @@
Advanced commands:
//run run the project (with Tiny C backend; Linux only!)
//pretty pretty print the inputfile
//genDepend generate a DOT file containing the
module dependency graph
//listDef list all defined conditionals and exit
//check checks the project for syntax and semantic
//parse parses a single file (for debugging Nimrod)
Advanced options:
-w, --warnings:on|off turn all warnings on|off
--warning[X]:on|off turn specific warning X on|off
--hints:on|off turn all hints on|off
--hint[X]:on|off turn specific hint X on|off
--lib:PATH set the path to the system.nim library
-c, --compileOnly compile only; do not assemble or link
--noLinking compile but do not link
--noMain do not generate a main procedure
--genScript generate a compile script (in the 'nimcache'
subdirectory named 'compile_$project$scriptext')
--os:SYMBOL set the target operating system (cross-compilation)
--cpu:SYMBOL set the target processor (cross-compilation)
--debuginfo enables debug information
-t, --passc:OPTION pass an option to the C compiler
-l, --passl:OPTION pass an option to the linker
--genMapping generate a mapping file containing
(Nimrod, mangled) identifier pairs
--lineDir:on|off generation of #line directive on|off
--checkpoints:on|off turn checkpoints on|off; for debugging Nimrod
--skipCfg do not read the general configuration file
--skipProjCfg do not read the project's configuration file
--gc:refc|boehm|none use Nimrod's native GC|Boehm GC|no GC
--index:FILE use FILE to generate a documenation index file
--putenv:key=value set an environment variable
--listCmd list the commands used to execute external programs
--parallelBuild=0|1|... perform a parallel build
value = number of processors (0 for auto-detect)
--verbosity:0|1|2|3 set Nimrod's verbosity level (0 is default)
-v, --version show detailed version information

37
doc/basicopt.txt Executable file
View file

@ -0,0 +1,37 @@
Usage::
nimrod command [options] inputfile [arguments]
Command:
//compile, c compile project with default code generator (C)
//compileToC, cc compile project with C code generator
//doc generate the documentation for inputfile
//rst2html converts a reStructuredText file to HTML
//rst2tex converts a reStructuredText file to TeX
Arguments:
arguments are passed to the program being run (if --run option is selected)
Options:
-p, --path:PATH add path to search paths
-o, --out:FILE set the output filename
-d, --define:SYMBOL define a conditional symbol
-u, --undef:SYMBOL undefine a conditional symbol
-f, --forceBuild force rebuilding of all modules
--stackTrace:on|off turn stack tracing on|off
--lineTrace:on|off turn line tracing on|off
--debugger:on|off turn Embedded Nimrod Debugger on|off
-x, --checks:on|off turn all runtime checks on|off
--objChecks:on|off turn obj conversion checks on|off
--fieldChecks:on|off turn case variant field checks on|off
--rangeChecks:on|off turn range checks on|off
--boundChecks:on|off turn bound checks on|off
--overflowChecks:on|off turn int over-/underflow checks on|off
-a, --assertions:on|off turn assertions on|off
--floatChecks:on|off turn all floating point (NaN/Inf) checks on|off
--nanChecks:on|off turn NaN checks on|off
--infChecks:on|off turn Inf checks on|off
--deadCodeElim:on|off whole program dead code elimination on|off
--opt:none|speed|size optimize not at all or for speed|size
--app:console|gui|lib generate a console|GUI application|dynamic library
-r, --run run the compiled program with given arguments
--advanced show advanced command line switches
-h, --help show this help

19
doc/keywords.txt Executable file
View file

@ -0,0 +1,19 @@
addr and as asm atomic
bind block break
case cast const continue converter
discard distinct div
elif else end enum except
finally for from generic
if implies import in include is isnot iterator
lambda let
macro method mod
nil not notin
object of or out
proc ptr
raise ref return
shl shr
template try tuple type
var
when while with without
xor
yield

View file

@ -160,7 +160,7 @@ underscores ``__`` are not allowed::
The following `keywords`:idx: are reserved and cannot be used as identifiers:
.. code-block:: nimrod
:file: ../data/keywords.txt
:file: keywords.txt
Some keywords are unused; they are reserved for future developments of the
language.

View file

@ -30,11 +30,11 @@ Command line switches
---------------------
Basis command line switches are:
.. include:: ../data/basicopt.txt
.. include:: basicopt.txt
Advanced command line switches are:
.. include:: ../data/advopt.txt
.. include:: advopt.txt
Configuration file