aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-06-14 11:43:43 +0200
committerShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-06-17 10:10:30 +0000
commitcee6e02d50729bb50fcfc189a25e775b5555319a (patch)
tree3c13f398794e48980b5e9bc1948811622f9d1475 /sources/pyside6/doc
parent68a9eb0842d4147c8914da78e7d4e5eb3f760e0e (diff)
Deployment Docs: Add instructions to generate a bug report
- Additionally, remove some comments from default.spec that are not relevant anymore. Pick-to: 6.7 Task-number: PYSIDE-1612 Change-Id: Iea2fed95507b6e649285e409cf8678287bf15a56 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc')
-rw-r--r--sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
index f348bc4f8..fab9965fe 100644
--- a/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
+++ b/sources/pyside6/doc/deployment/deployment-pyside6-deploy.rst
@@ -224,3 +224,29 @@ are required to be installed on the system:
* - macOS
- dyld_info
- Available by default from macOS 12 and upwards
+
+Creating a bug report
+=====================
+
+If you are unsure if the bug is from ``pyside6-deploy`` or ``Nuitka``:
+
+#. Create a bug report in Qt for Python. See instructions
+ `here <https://wiki.qt.io/Qt_for_Python/Reporting_Bugs/>`_.
+
+#. Run ``pyside6-deploy`` command with the ``--verbose`` option and replace ``--quiet`` with
+ ``--verbose`` in the ``extra_args`` parameter in the ``pysidedeploy.spec`` file. Attach the
+ output from stdout to the bug report.
+
+#. Attach a minimal example that reproduces the bug with the bug report.
+
+If you think the bug originates from ``Nuitka``:
+
+#. Try using a newer version of ``Nuitka``. You can change this from the ``packages`` parameter in
+ your generated ``pysidedeploy.spec`` file.
+
+#. If the bug persists, create a bug report on the
+ `Nuitka GitHub page <https://github.com/Nuitka/Nuitka/issues>`_.
+
+ * Run ``pyside6-deploy`` with the ``--dry-run`` option to see the actual ``Nuitka`` command
+ generated. Attach the ``Nuitka`` command ran to the bug report.
+ * Follow the Nuitka bug report template to create a bug report.