Skip to content

docs: align set_source duplicate_output wording with implementation - #130

Merged
Groveer merged 1 commit into
linuxdeepin:masterfrom
wineee:doc-fix
Oct 26, 2026
Merged

Groveer merged 1 commit into
linuxdeepin:masterfrom
wineee:doc-fix

Conversation

@wineee

@wineee wineee commented Oct 26, 2026 •

Copy link
Copy Markdown
Member
  1. set_source on an existing group member now promotes it to source
  2. remove the duplicate_output failure case from set_source description
  3. keep duplicate_output only for add_output duplicate additions

Log: No user-facing changes

Influence:

  1. Verify set_source on a current mirror promotes it to source on commit
  2. Verify no operation_failed duplicate_output is emitted by set_source
  3. Verify add_output on an existing member still reports duplicate_output

docs: 对齐 set_source duplicate_output 措辞与实现

  1. set_source 对本组已有成员现改为直接提升为源
  2. 从 set_source 描述中移除 duplicate_output 失败情形
  3. duplicate_output 仅保留给 add_output 的重复添加

Log: 无用户可见变化

Influence:

  1. 验证对当前 mirror 调用 set_source 提交后将其提升为源
  2. 验证 set_source 不再发送 operation_failed duplicate_output
  3. 验证对已有成员调用 add_output 仍返回 duplicate_output

PMS: TASK-395091

Summary by Sourcery

Update output-group protocol documentation to accurately describe set_source promotion and error behavior.

Enhancements:

  • Align the output-group protocol documentation with set_source behavior by documenting promotion of existing members and removing duplicate_output from its failure conditions.

Documentation:

  • Clarify that duplicate_output applies to duplicate add_output requests while set_source promotes existing group members, including current mirrors.

1. set_source on an existing group member now promotes it to source
2. remove the duplicate_output failure case from set_source description
3. keep duplicate_output only for add_output duplicate additions

Log: No user-facing changes

Influence:
1. Verify set_source on a current mirror promotes it to source on commit
2. Verify no operation_failed duplicate_output is emitted by set_source
3. Verify add_output on an existing member still reports duplicate_output

docs: 对齐 set_source duplicate_output 措辞与实现

1. set_source 对本组已有成员现改为直接提升为源
2. 从 set_source 描述中移除 duplicate_output 失败情形
3. duplicate_output 仅保留给 add_output 的重复添加

Log: 无用户可见变化

Influence:
1. 验证对当前 mirror 调用 set_source 提交后将其提升为源
2. 验证 set_source 不再发送 operation_failed duplicate_output
3. 验证对已有成员调用 add_output 仍返回 duplicate_output

PMS: TASK-395091
@sourcery-ai

sourcery-ai Bot commented Oct 26, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the output-group protocol documentation to match implementation: set_source now directly promotes an existing member, including a current mirror, without emitting duplicate_output, while duplicate additions remain associated with add_output.

File-Level Changes

Change Details Files
Align the set_source protocol documentation with the compositor’s promotion behavior for existing group members.
  • Document that an existing mirror is promoted directly to the configured source and the mirror list is re-resolved.
  • Remove duplicate_output from set_source failure conditions while retaining invalid_output and output_in_use.
  • Clarify idempotent behavior when setting the already effective source and distinguish it from the existing-member promotion path.
dde/treeland-output-group-manager-unstable-v1.xml
Constrain duplicate_output semantics to duplicate add_output requests.
  • Ensure the set_source documentation no longer instructs clients to remove an existing member first.
  • Preserve duplicate_output as the documented result for repeated output additions.
dde/treeland-output-group-manager-unstable-v1.xml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@Groveer
Groveer added this pull request to the merge queue Oct 26, 2026
@deepin-ci-robot

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Groveer, wineee

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Merged via the queue into linuxdeepin:master with commit a4d5688 Oct 26, 2026
4 of 5 checks passed
@wineee
wineee deleted the doc-fix branch October 26, 2026 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants