protocols: mark all treeland protocols as experimental with no compatibility guarantees - #86
Merged
Merged
Conversation
…ibility guarantees All Treeland Wayland protocol extensions are experimental and may change at any time, including in backward-incompatible ways, without any compatibility guarantees. Changes: - Add unified experimental disclaimer to protocol-level <description> in all 22 XML protocol files (6 files with existing description: appended; 16 files without: new protocol-level <description> added) - Remove old 'testing phase' warning blocks from interface descriptions in 7 files (dde-shell, foreign-toplevel, personalization, screensaver, shortcut-v1, shortcut-v2, keyboard-state-notify) — the old wording promised version-bump discipline which contradicts 'no compatibility guarantees' - Replace old warning in keyboard-state-notify protocol-level description with the new experimental disclaimer - Add 'Experimental status' section to README.md and README.zh_CN.md - Pre-populate experimental disclaimer in treeland-protocol-template.xml - Add rule 12 to treeland-wayland-protocol-rules.md requiring the experimental disclaimer in every protocol-level <description> No interface version bumps, no wire protocol changes. Closes: WM-248
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @deepin-wm, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
Reviewer's GuideMarks all Treeland Wayland protocols as explicitly experimental by standardizing a single disclaimer in protocol-level descriptions, removing contradictory old testing-phase warnings, and updating documentation and authoring rules to prevent future regressions. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
deepin pr auto review★ 总体评分：100分■ 【总体评价】
■ 【详细分析】
■ 【改进建议代码示例】 <!-- 当前变更已完美符合所有规范，无需额外改进代码示例 -->
<!-- 以下为符合本次新增第12节规则的标准协议文件头结构示意 -->
<protocol name="treeland_example_protocol_v1">
<copyright>
SPDX-FileCopyrightText: 2025 UnionTech Software Technology Co., Ltd.
SPDX-License-Identifier: MIT
</copyright>
<description summary="example protocol">
Warning! This protocol is EXPERIMENTAL and under active development.
It may change at any time, including in backward-incompatible ways,
without incrementing the interface major version and without prior
notice. No compatibility guarantees of any kind are provided. Clients
and compositors must track the upstream definition in treeland-protocols
and must not rely on the current interface names, requests, events, or
semantics remaining stable across releases.
</description>
<interface name="treeland_example_manager_v1" version="1">
<!-- 接口定义，不再包含实验性警告 -->
</interface>
</protocol> |
wineee
approved these changes
Aug 13, 2026
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: deepin-wm, wineee The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
All Treeland Wayland protocol extensions are experimental and may change at any time, including in backward-incompatible ways, without any compatibility guarantees.
Closes: WM-248
Changes
XML protocol files (22 files in
xml/)Unified experimental disclaimer added to the protocol-level
<description>in every XML file:<description>: disclaimer appended (capture, input-manager, keyboard-state-notify, remote-subsurface, wine-window-management, wine-window-state)<description>: new<description>block added after<copyright>(app-id-resolver, dde-shell, ddm, foreign-toplevel, output-manager, personalization, prelaunch-splash-v1/v2, screensaver, shortcut-v1/v2, virtual-output-manager, wallpaper-color, wallpaper-manager, wallpaper-shell, window-management)Old warning cleanup (7 files)
Removed old "testing phase" warning blocks from interface descriptions in:
The old wording ("Backward incompatible changes can only be done by creating a new major version") promised version-bump discipline, which directly contradicts the issue requirement of "no compatibility guarantees." These blocks were removed to avoid self-contradicting documentation.
Documentation
README.md: added "Experimental status" sectionREADME.zh_CN.md: added "实验性状态" sectionSkill template & rules (prevent future regression)
treeland-protocol-template.xml: pre-populated experimental disclaimer in protocol-level<description>treeland-wayland-protocol-rules.md: added section 12 requiring the experimental disclaimer in every protocol-level<description>Notes
versionbumps, nosinceadditions — pure documentation changeCMakeLists.txtchanges — no files added or removedSummary by Sourcery
Clarify that all Treeland Wayland protocols in this repository are experimental and provide no compatibility guarantees, and align protocol XMLs, templates, and authoring rules with that status.
Enhancements:
Documentation: