Documents nimcache file naming scheme. Refs #852.

This commit is contained in:
Grzegorz Adam Hankiewicz 2014-07-27 22:27:21 +02:00
commit 2ade6ab94d
2 changed files with 66 additions and 4 deletions

View file

@ -152,10 +152,12 @@ the first matching file is used.
Generated C code directory
--------------------------
The generated files that Nimrod produces all go into a subdirectory called
``nimcache`` in your project directory. This makes it easy to delete all
generated files.
The generated files that Nimrod produces all go into a subdirectory called
``nimcache`` in your project directory. This makes it easy to delete all
generated files. Files generated in this directory follow a naming logic which
you can read about in the `Nimrod Backend Integration document
<backends.html#nimcache-naming-logic>`_.
However, the generated C code is not platform independent. C code generated for
Linux does not compile on Windows, for instance. The comment on top of the
C file lists the OS, CPU and CC the file has been compiled for.