Skip to content

[Debug] Escape LLDB syntax in debugDescription #75300

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

Merged

Conversation

kastiglione
Copy link
Contributor

@kastiglione kastiglione commented Jul 17, 2024

  • Explanation:
    When using @DebugDescription, only allow use of LLDB Summary Strings syntax from lldbDescription properties. When @DebugDescription is applied to existing debugDescription properties, escape any $, as the output of debugDescription is never interpreted by LLDB.
  • Scope:
    This will not break existing code. Adopters will almost certainly be unaffected.
  • Original PRs:
    [Debug] Escape LLDB syntax in debugDescription #75300
  • Risk:
    No risk, it fixes a potentially surprising bug if an existing debugDescription was reused with this macro, and the string contained the substring ${.
  • Testing:
    Swift tests, CI.
  • Reviewers:
    @hborla, @stephentyrone, @DougGregor

@kastiglione kastiglione requested a review from a team as a code owner July 17, 2024 18:03
@kastiglione
Copy link
Contributor Author

See the commit 30bf325 for the changes unique to this PR. The base commit is from #74701.

@kastiglione
Copy link
Contributor Author

@swift-ci test

@stephentyrone stephentyrone self-requested a review July 17, 2024 18:38
Copy link
Member

@hborla hborla left a comment

Choose a reason for hiding this comment

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

Please fill out the release cherry pick template

@kastiglione kastiglione requested a review from hborla July 17, 2024 21:13
@kastiglione kastiglione merged commit d4d9cc2 into release/6.0 Jul 25, 2024
5 checks passed
@kastiglione kastiglione deleted the dl/Debug-Escape-LLDB-syntax-in-debugDescription branch July 25, 2024 17:08
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