README.packagers 1.71 KB
Newer Older
Sven Brauch's avatar
Sven Brauch committed
1 2 3 4 5 6 7 8 9 10 11
This information is intended for package mantainers.

First of all, thanks for packaging this software! If you encounter
any issues which you think should be fixed upstream, please report
a bug or send a patch, I'll be happy to accept it if it makes sense.

Notes
=====
This is a collection of notes about what might be of interest,
related to packaging.

Sven Brauch's avatar
Sven Brauch committed
12 13
Supported Python versions
-------------------------
14
Python 2 support was dropped, and we just support the latest few minor
Sven Brauch's avatar
Sven Brauch committed
15
releases of Python 3 right now.
16

17 18 19 20 21 22 23 24 25
NOTE: Since we use the upstream CPython parser, compiling against an old
 version will restrict kdev-python's syntax support to that version.
This will cause false-positive warnings to the user and failed type-inference
 for newer Python code. Then we get bug reports upstream for features that
 were already implemented.

Please compile against the newest supported version unless there is no other
 possible alternative.

Sven Brauch's avatar
Sven Brauch committed
26 27
Python fork
-----------
Sven Brauch's avatar
Sven Brauch committed
28 29 30
This branch, which contains the python3 version of kdev-python, does no longer
contain a fork of python. Instead, it links against your system's python.
Python is both a build- and a runtime dependency of this program.
Sven Brauch's avatar
Sven Brauch committed
31 32 33 34 35 36 37 38

documentation_data directory
----------------------------
This directory does NOT contain user documentation for the plugin.
It MUST be packaged together with the program, as it contains runtime
data which is necessary for the program to work correctly (such as
representations of python's built-in data types, which are then read
by the parser etc.).
Sven Brauch's avatar
Sven Brauch committed
39 40 41 42 43 44 45 46 47

Licensing notes
---------------
The following files are not copyrighted:
Everything in duchain/tests/data/
Everything in documentation_files/
Everything in correction_files/
Everything in app_templates/
example_ast.py