From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Wed, 26 Oct 2022 01:07:28 +0000 (+0200)
Subject: docs: document how to unbreak editable mode in the readme
X-Git-Tag: pool-3.1.4~12
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=dde53f3ee8fa4a2a351f424567d5192755c310ce;p=thirdparty%2Fpsycopg.git

docs: document how to unbreak editable mode in the readme
---

diff --git a/README.rst b/README.rst
index f71a53d2b..040c9c158 100644
--- a/README.rst
+++ b/README.rst
@@ -58,11 +58,16 @@ requirements::
     python -m venv .venv
     source .venv/bin/activate
     pip install -e "./psycopg[dev,test]"    # for the base Python package
-    pip install -e ./psycopg_c              # for the C extension module
     pip install -e ./psycopg_pool           # for the connection pool
+    pip install ./psycopg_c                 # for the C speedup module
 
 .. __: https://pip.pypa.io/en/stable/reference/pip_install/#install-editable
 
+Please add ``--config-settings editable_mode=strict`` to the ``pip install
+-e`` above if you experience `editable mode broken`__.
+
+.. __: https://github.com/pypa/setuptools/issues/3557?
+
 Now hack away! You can use tox to validate the code::
 
     pip install tox