-
Notifications
You must be signed in to change notification settings - Fork 456
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: migrate kde neon extensions #5220
base: main
Are you sure you want to change the base?
docs: migrate kde neon extensions #5220
Conversation
This is a placeholder commit. Will be squashed when other extension work is merged.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5220 +/- ##
==========================================
- Coverage 94.88% 89.68% -5.21%
==========================================
Files 658 342 -316
Lines 55189 22636 -32553
==========================================
- Hits 52364 20300 -32064
+ Misses 2825 2336 -489 ☔ View full report in Codecov by Sentry. |
Will be reorienting around KDE 6 before opening for full review. |
Runtime environment | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
The KDE neon extensions also sets various runtime environment variables for apps. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The KDE neon extensions also sets various runtime environment variables for apps. | |
The KDE neon extensions also set various runtime environment variables for apps. |
Included layouts | ||
---------------- | ||
|
||
The KDE neon 6 extension adds the following `layout |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The KDE neon 6 extension adds the following `layout | |
The KDE neon 6 extension adds the following `layouts |
|
||
Here's an example of the result of Snapcraft expanding project files that use the KDE | ||
neon 5 and 6 extensions, immediately prior to build. It demonstrates the added plugs, | ||
packages, variables, and layouts, that the extensions include in projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
packages, variables, and layouts, that the extensions include in projects. | |
packages, variables, and layouts that the extensions include in projects. |
kcalc: | ||
command: usr/bin/kcalc | ||
extensions: | ||
- kde-neon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IDK whether this is relevant but we probably should use the neon 6 extension here if this file gets merged.
<https://snapcraft.io/kf5-5-113-qt-5-15-11-core22-sdk>`_ | ||
|
||
The extensions are designed for C++ based Qt/KDE Frameworks apps. They don't provide the | ||
bindings needed in PySide2 (Qt for Python) or PyQt apps. The extensions also don't |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bindings needed in PySide2 (Qt for Python) or PyQt apps. The extensions also don't | |
bindings needed for PySide2 (Qt for Python) or PyQt apps. The extensions also don't |
For an example of a part's ``build-environment`` section modified by the KDE neon 6 | ||
extension, it sets the ``PATH``, ``XDG_DATA_DIRS``, and ``SNAPCRAFT_CMAKE_ARGS`` | ||
environment variables during build. These defaults can be overridden by being | ||
pre-emptively declared in the project file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These sentences sound a bit awkward
.. literalinclude:: ../code/extensions/kde-neon-extension-kcalc-expanded.diff | ||
:language: diff | ||
:lines: 3- | ||
:emphasize-lines: 15-19, 27-28, 64-103 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:emphasize-lines: 15-19, 27-28, 64-103 | |
:emphasize-lines: 15-19, 27-28, 58-103 |
.. group-tab:: KDE neon 6 | ||
|
||
The original is a `project file | ||
<https://invent.kde.org/alexlowe/keysmith/-/blob/aml/snapcraft/snapcraft.yaml>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tox run -m lint
?tox run -e test-py310
? (supported versions:py39
,py310
,py311
,py312
)For review, please focus on
docs/reference/extensions/kde-neon-extensions.rst
. The other files will be merged through another PR.