Documents passC/passL pragmas. Refs #506.

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/nimrodc.txt b/doc/nimrodc.txt
index 4ae5eae69..5e2bfb09b 100644
--- a/doc/nimrodc.txt
+++ b/doc/nimrodc.txt
@@ -292,6 +292,35 @@ The `link`:idx: pragma can be used to link an additional file with the project:
   {.link: "myfile.o".}

 

 

+PassC pragma
+------------
+The `passC`:idx: pragma can be used to pass additional parameters to the C
+compiler like you would using the commandline switch ``--passC``:
+
+.. code-block:: Nimrod
+  {.passC: "-Wall -Werror".}
+
+Note that you can use ``gorge`` from the `system module <system.html>`_ to
+embed parameters from an external command at compile time:
+
+.. code-block:: Nimrod
+  {.passC: gorge("pkg-config --cflags sdl").}
+
+PassL pragma
+------------
+The `passL`:idx: pragma can be used to pass additional parameters to the linker
+like you would using the commandline switch ``--passL``:
+
+.. code-block:: Nimrod
+  {.passL: "-lSDLmain -lSDL".}
+
+Note that you can use ``gorge`` from the `system module <system.html>`_ to
+embed parameters from an external command at compile time:
+
+.. code-block:: Nimrod
+  {.passL: gorge("pkg-config --libs sdl").}
+
+
 Emit pragma

 -----------

 The `emit`:idx: pragma can be used to directly affect the output of the