Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add BufferedSerial class to replace UARTSerial #12207

Merged
merged 3 commits into from
Jan 16, 2020
Merged

Add BufferedSerial class to replace UARTSerial #12207

merged 3 commits into from
Jan 16, 2020

Conversation

hugueskamba
Copy link
Collaborator

Summary of changes

Implement the BufferedSerial class to replace UARTSerial. BufferedSerial is UARTSerial renamed to convey the original purpose of the class. Also remove usage of UARTSerial in Mbed OS Core diretories

Impact of changes

Migration actions required

Documentation

Pull request type 

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[X] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results 

[] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[X] Tests supplied as part of this PR

Reviewers

@evedon @kjbracey-arm

This was referenced Jan 8, 2020
Merged
Merged
Merged
@ciarmcom ciarmcom requested review from evedon, kjbracey and a team January 8, 2020 10:01
@ciarmcom
Copy link
Member

ciarmcom commented Jan 8, 2020

@hugueskamba, thank you for your changes.
@kjbracey-arm @evedon @ARMmbed/mbed-os-maintainers @ARMmbed/mbed-os-test @ARMmbed/mbed-os-core please review.

@hugueskamba hugueskamba mentioned this pull request Jan 8, 2020
Merged
@0xc0170 0xc0170 added the release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0 label Jan 8, 2020
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 8, 2020

Please review astyle failures

0xc0170
0xc0170 previously requested changes Jan 8, 2020
View reviewed changes
drivers/source/BufferedSerial.cpp Outdated Show resolved Hide resolved
drivers/source/BufferedSerial.cpp Show resolved Hide resolved
drivers/BufferedSerial.h Outdated Show resolved Hide resolved
drivers/BufferedSerial.h Show resolved Hide resolved
@hugueskamba
Copy link
Collaborator Author

Please review astyle failures

Done.

@hugueskamba hugueskamba mentioned this pull request Jan 8, 2020
Merged
@0xc0170 0xc0170 self-requested a review January 9, 2020 09:33
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 9, 2020

scheduled first CI job, there are few other PRs depending on this one. Please review

@mbed-ci
Copy link

mbed-ci commented Jan 9, 2020

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

evedon
evedon requested changes Jan 9, 2020
View reviewed changes
drivers/BufferedSerial.h Outdated Show resolved Hide resolved
drivers/BufferedSerial.h Show resolved Hide resolved
drivers/source/BufferedSerial.cpp Show resolved Hide resolved
drivers/source/BufferedSerial.cpp Outdated Show resolved Hide resolved
@0xc0170 0xc0170 self-requested a review January 10, 2020 15:04
@hugueskamba
Implement the BufferedSerial class to replace UARTSerial
18f677e 
`BufferedSerial` is `UARTSerial` renamed to convey the original purpose
of the class.
@hugueskamba
Mark UARTSerial as deprecated
5fa7627
@hugueskamba
Remove usage of UARTSerial in Mbed OS Core diretories
a74ffac 
Replace with BufferedSerial as UARTSerial has been deprecated.
@0xc0170 0xc0170 requested a review from evedon January 13, 2020 13:48
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 15, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Jan 15, 2020

Test run: FAILED

Summary: 1 of 11 test jobs failed
Build number : 2
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_greentea-test

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 15, 2020

One target io serial error, restarted tests

@0xc0170 0xc0170 requested a review from bulislaw January 15, 2020 14:28
@0xc0170 0xc0170 added release-version: 6.0.0-alpha-2 Second pre-release version of 6.0.0 needs: review and removed needs: CI labels Jan 15, 2020
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 15, 2020

@bulislaw @kjbracey-arm Please review, CI passed for the latest update

@0xc0170 0xc0170 merged commit 18c941c into ARMmbed:master Jan 16, 2020
@adbridge
Copy link
Contributor

@hugueskamba shouldn't there be documentation changes to go along with this ?
@bulislaw @0xc0170 this is adding and removing APIs so should this be a breaking change ?

@hugueskamba
Copy link
Collaborator Author

hugueskamba commented Feb 17, 2020 •
edited
Loading

@hugueskamba shouldn't there be documentation changes to go along with this ?

The documentation is currently being reviewed.

@0xc0170
Copy link
Contributor

0xc0170 commented Feb 17, 2020 •
edited
Loading

@bulislaw @0xc0170 this is adding and removing APIs so should this be a breaking change ?

I've checked, this only deprecates the older object, it should be backward compatible. However, release notes should be added for this feature update.

@mprse mprse mentioned this pull request Feb 24, 2020
Merged
@hugueskamba hugueskamba deleted the hk-add-buffered_serial branch June 30, 2020 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@evedon evedon evedon approved these changes

@kjbracey kjbracey kjbracey approved these changes

@0xc0170 0xc0170 0xc0170 approved these changes

@bulislaw bulislaw Awaiting requested review from bulislaw

Assignees
No one assigned
Labels
release-version: 6.0.0-alpha-2 Second pre-release version of 6.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@hugueskamba @ciarmcom @0xc0170 @mbed-ci @adbridge @kjbracey @evedon