Skip to content

[skip changelog] Remove outdated information re: debug system from platform spec #1203

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
merged 1 commit into from
Mar 1, 2021
Merged

[skip changelog] Remove outdated information re: debug system from platform spec #1203

merged 1 commit into from
Mar 1, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Feb 28, 2021

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

docs update

  • What is the current behavior?

Since the time the documentation for the initial experimental debugging configuration system was added to the Arduino
Platform Specification (#882), the system has changed significantly, resulting in some of the documentation no longer being applicable to the current version of Arduino CLI.

  • What is the new behavior?

The outdated information is removed, leaving the parts that are still correct.
Since the documentation is versioned, users of older Arduino CLI versions from before the system change still have easy access to that information.

Does this PR introduce a breaking change

no

is titled accordingly

yes

  • Other information:

The new debug system will be fully documented at a later time.

@per1234 per1234 requested a review from alranel February 28, 2021 20:10
…atform spec

Since the time the documentation for the initial experimental debugging configuration system was added to the Arduino
Platform Specification, the system has changed significantly, resulting in some of the documentation no longer being
applicable to the current version of Arduino CLI. This only removes the outdated information, leaving the parts that are
still correct. The new debug system will be fully documented at a later time.
@per1234 per1234 requested a review from ubidefeo March 1, 2021 05:56
Copy link

@ubidefeo ubidefeo left a comment

Choose a reason for hiding this comment

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

good

@per1234 per1234 merged commit b2b9fba into arduino:master Mar 1, 2021
@per1234 per1234 deleted the remove-debug-spec branch March 1, 2021 06:46
@per1234 per1234 self-assigned this Nov 23, 2021
@per1234 per1234 added topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project labels Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants