From: Denis Laxalde <denis.laxalde@dalibo.com>
Date: Mon, 10 Oct 2022 15:26:38 +0000 (+0200)
Subject: test: document --pq-trace and --pq-debug pytest option
X-Git-Tag: 3.1.4~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d7a3785804ac97e139355e52bded734a13b62f26;p=thirdparty%2Fpsycopg.git

test: document --pq-trace and --pq-debug pytest option
---

diff --git a/tests/README.rst b/tests/README.rst
index 2e0511c1c..63c72382a 100644
--- a/tests/README.rst
+++ b/tests/README.rst
@@ -55,6 +55,13 @@ Test options
       [...]
       ==== 1877 passed, 2 skipped, 169 deselected, 48 xfailed in 13.47s =====
 
+- ``pytest`` option ``--pq-trace={TRACEFILE,STDERR}`` can be used to capture
+  libpq trace. When using ``stderr``, the output will only be shown for
+  failing or in-error tests, unless ``-s/--capture=no`` option is used.
+
+- ``pytest`` option ``--pq-debug`` can be used to log access to libpq's
+  ``PGconn`` functions.
+
 
 Testing in docker
 -----------------