Skip to content

Conversation

hugueskamba
Copy link
Collaborator

@hugueskamba hugueskamba commented Jan 8, 2020

Summary of changes

BufferedSerial is UARTSerial renamed to convey the original purpose
of the class. It is the recommended buffered I/O serial class.

Impact of changes

Migration actions required

Documentation


Pull request type

[X] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] 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)
[X] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@AnttiKauppila


@ciarmcom ciarmcom requested review from a team and AnttiKauppila January 8, 2020 10:00
@ciarmcom
Copy link
Member

ciarmcom commented Jan 8, 2020

@hugueskamba, thank you for your changes.
@AnttiKauppila @ARMmbed/mbed-os-wan @ARMmbed/mbed-os-maintainers please review.

@hugueskamba hugueskamba force-pushed the hk-replace-uartserial-cellular branch from ed7fc0d to 49618c4 Compare January 8, 2020 11:26
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 8, 2020

Similar failure than in another ESP PR

Copy link

@AnttiKauppila AnttiKauppila left a comment

Choose a reason for hiding this comment

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

You should remove drivers/ from path where used because it is not be needed

@hugueskamba hugueskamba force-pushed the hk-replace-uartserial-cellular branch from 49618c4 to 15c92b6 Compare January 8, 2020 13:54
@hugueskamba
Copy link
Collaborator Author

You should remove drivers/ from path where used because it is not be needed

@AnttiKauppila
Mentioning it once to account for all should have been sufficient. 😊
It was added not because of a need but rather because it makes it very clear which library it is included from.
In any case, it has been removed if you prefer not to have it. 👍

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 8, 2020

I believe it is preferred to use more explicit include path, including the module. Not considering how our tools work (including a lot), when we use anything else, this will still stand and work without any troubles. Otherwise we might have some surprises with some tools. I would expect this to be in our guidelines. I've just checked, it's there:

Always include header files using the module directory in the path. For example: #include “lwip/lwip-interface.h”, #include “drivers/Ticker.h”. Limit the include path to the module directory. This allows moving the module in the future.

We already updated platform/drivers code.

@hugueskamba
Copy link
Collaborator Author

hugueskamba commented Jan 8, 2020

I believe it is preferred to use more explicit include path, including the module. Not considering how our tools work (including a lot), when we use anything else, this will still stand and work without any troubles. I would expect this to be in our guidelines. I've just checked, it's there:

Always include header files using the module directory in the path. For example: #include “lwip/lwip-interface.h”, #include “drivers/Ticker.h”. Limit the include path to the module directory. This allows moving the module in the future.

We already updated platform/drivers code.

@AnttiKauppila @0xc0170 Should I revert back to what I had originally (it takes me no time)?

@evedon
Copy link
Contributor

evedon commented Jan 8, 2020

I believe it is preferred to use more explicit include path, including the module. Not considering how our tools work (including a lot), when we use anything else, this will still stand and work without any troubles. I would expect this to be in our guidelines. I've just checked, it's there:

Always include header files using the module directory in the path. For example: #include “lwip/lwip-interface.h”, #include “drivers/Ticker.h”. Limit the include path to the module directory. This allows moving the module in the future.

We already updated platform/drivers code.

@AnttiKauppila @0xc0170 Should I revert back to what I had originally (it takes me no time)?

While working on public headers clean-up this summer, we started to update mbed-os core code with more explicit include paths that specify the module.
@hugueskamba Please revert back to what you had originally

@hugueskamba hugueskamba force-pushed the hk-replace-uartserial-cellular branch from 15c92b6 to 5348c9d Compare January 9, 2020 07:27
@hugueskamba
Copy link
Collaborator Author

@hugueskamba Please revert back to what you had originally

Done.

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 16, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Jan 16, 2020

Test run: FAILED

Summary: 1 of 4 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_unittests

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 16, 2020

Please review failures

[2020-01-16T14:08:51.258Z] /builds/ws/mbed-os-ci_unittests@2/unitTest-4999/mbed-os/UNITTESTS/stubs/BufferedSerial_stub.cpp:103:29: error: no ‘void mbed::BufferedSerial::unlock()’ member function declared in class ‘mbed::BufferedSerial’

[2020-01-16T14:08:51.258Z]  void BufferedSerial::unlock()

`BufferedSerial` is `UARTSerial` renamed to convey the original purpose
of the class. It is the recommended buffered I/O serial class.
@hugueskamba hugueskamba force-pushed the hk-replace-uartserial-cellular branch from 537319c to 9e11e5b Compare January 16, 2020 16:22
@hugueskamba
Copy link
Collaborator Author

UNITTESTS/stubs/BufferedSerial_stub.cpp

Thank you. This should fix it.

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 17, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Jan 17, 2020

Test run: SUCCESS

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

@0xc0170 0xc0170 added release-version: 6.0.0-alpha-2 Second pre-release version of 6.0.0 and removed needs: CI labels Jan 17, 2020
@0xc0170 0xc0170 merged commit 4924264 into ARMmbed:master Jan 17, 2020
@hugueskamba hugueskamba deleted the hk-replace-uartserial-cellular branch June 30, 2020 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-version: 6.0.0-alpha-2 Second pre-release version of 6.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants