Document briefcase.debuggers plugin interface#2691
Merged
freakboy3742 merged 3 commits intobeeware:mainfrom Feb 17, 2026
Merged
Document briefcase.debuggers plugin interface#2691freakboy3742 merged 3 commits intobeeware:mainfrom
freakboy3742 merged 3 commits intobeeware:mainfrom
Conversation
Add a new `briefcase.debuggers` section to the plugins reference page describing the BaseDebugger abstract base class, its required properties, and entry point registration. Apply the scout rule to the rest of the plugins page: - Fix copy-paste bug in bootstraps section (entry point group name pointed to briefcase.platforms instead of briefcase.bootstraps) - Add #platform-interface anchor ID to the platforms heading - Standardize "For example" lead-in phrasing across all sections - Fix code block language tags from python to toml - Fix Xcode casing (XCode -> Xcode) and add to spelling wordlist Link the debugger plugin interface from the build and run command reference pages, and link the platform plugin interface from the FAQ.
freakboy3742
approved these changes
Feb 17, 2026
Member
freakboy3742
left a comment
freakboy3742
left a comment
There was a problem hiding this comment.
Thanks for this update, and for fixing the stray typos you picked up along the way.
I've fixed the remaining Xcode spelling issues, and added some additional details about the exact interface that a debugger must implemented.
| Wunjo | ||
| Xauth | ||
| XCode | ||
| Xcode |
Member
There was a problem hiding this comment.
Good catch on this - but we should also remove the XCode entry (and fix the problems that exist because of the bad entry...)
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
2 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.
Add a new
briefcase.debuggerssection to the plugins reference page describing theBaseDebuggerabstract base class, its required properties, and entry point registration. Resolves #2681Apply the scout rule to the rest of the plugins page:
Link the debugger plugin interface from the build and run command reference pages, and link the platform plugin interface from the FAQ.
Groundwork for more plugin work in #2687
PR Checklist: