docs: add faq entry about broken .pc files due to python wheels

2017-12-11 10:55:37 +01:00 · 2017-12-11 10:55:37 +01:00 · 469c84ecd0
parent 1d2c452ce2
commit 469c84ecd0
2 changed files with 18 additions and 0 deletions
--- a/docs/faq.rst
+++ b/docs/faq.rst
@ -0,0 +1,17 @@
+==========================
+Frequently Asked Questions
+==========================
+
+The paths in the installed pkg-config file are wrong. Why?
+    Multiple reasons:
+
+    * This can happen if you install from a Python wheel. Since you
+      can't pass a prefix to setup.py bdist_wheel you don't have control over
+      the paths in the .pc file.
+
+    * When installing with pip: pip will sometimes create a wheel and cache
+      it for future installations. In case the next installation is to a
+      different prefix the .pc file contains the paths of the first
+      installation.
+
+    If you can think of any way to improve this, please tell us :)
--- a/docs/index.rst
+++ b/docs/index.rst
@ -19,6 +19,7 @@
   reference/index
   pycairo_c_api
   resources
+   faq

 .. currentmodule:: cairo
 .. title:: Overview