summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2017-07-21 06:36:37 -0700
committerEli Bendersky <eliben@gmail.com>2017-07-21 06:36:37 -0700
commit2fdaa9870670813b556e3b7c3dc4f4011dccc692 (patch)
tree0fa99b3116257adbb848f369237c3d7d77c9739a /README.rst
parent673accec311a027c22b0718d753f8da922915305 (diff)
downloadpycparser-2fdaa9870670813b556e3b7c3dc4f4011dccc692.tar.gz
Add README clarification re -OO; relevant to #198
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e94bb7e..951946e 100644
--- a/README.rst
+++ b/README.rst
@@ -87,6 +87,13 @@ Prerequisites
uses is PLY, which is bundled in ``pycparser/ply``. The current PLY version is
3.10, retrieved from `<http://www.dabeaz.com/ply/>`_
+Note that **pycparser** (and PLY) uses docstrings for grammar specifications.
+Python installations that strip docstrings (such as when using the Python
+``-OO`` option) will fail to instantiate and use **pycparser**. You can try to
+work around this problem by making sure the PLY parsing tables are pre-generated
+in normal mode; this isn't an officially supported/tested mode of operation,
+though.
+
Installation process
--------------------