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.

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

Organize source files and add Doxygen labels #11441

Merged
merged 1 commit into from Sep 11, 2019

Conversation

@gpsimenos
Copy link
Contributor

commented Sep 9, 2019

Description

  • Move source files from mbed-os/platform to mbed-os/platform/source
  • Move internal header files from mbed-os/platform to mbed-os/platform/internal
  • Add Doxygen groups to header files

Pull request type

[ ] Fix
[X] Refactor
[ ] Target update
[ ] Functionality change
[X] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@hugueskamba @evedon @kjbracey-arm

@gpsimenos gpsimenos force-pushed the gpsimenos:gp-move-source-files branch from a20f246 to 6eccd8c Sep 9, 2019
@ciarmcom ciarmcom requested review from evedon, hugueskamba, kjbracey-arm and ARMmbed/mbed-os-maintainers Sep 9, 2019
@ciarmcom

This comment has been minimized.

Copy link
Member

commented Sep 9, 2019

@gpsimenos gpsimenos force-pushed the gpsimenos:gp-move-source-files branch from 6eccd8c to d3b6353 Sep 9, 2019
Copy link
Contributor

left a comment

Doxygen is missing from mbed_os_timer.h. It would be useful to add.

platform/mbed_thread.h Outdated Show resolved Hide resolved
@gpsimenos

This comment has been minimized.

Copy link
Contributor Author

commented Sep 9, 2019

Doxygen is missing from mbed_os_timer.h. It would be useful to add.

Doxygen is not generating any output for this file when added to a group:

Screen Shot 2019-09-09 at 15 37 01

@gpsimenos gpsimenos force-pushed the gpsimenos:gp-move-source-files branch from d3b6353 to c3c84c0 Sep 9, 2019
@gpsimenos gpsimenos requested a review from evedon Sep 9, 2019
* @{
*
* @defgroup mbed_SysTimer SysTimer class
* \defgroup mbed_SysTimer SysTimer class

This comment has been minimized.

Copy link
@kjbracey-arm

kjbracey-arm Sep 10, 2019

Contributor

I believe this file is not included by any public header, so can go into source. (The logic being that the source directory contains all source and headers that could be removed from a binary-only distribution, or not be on the include path at all for stuff outside the Mbed OS "source" directories).

Same for mbed_os_timer.h

Except in both cases they're being accessed from a different source directory to this one. Not sure if that forces them to be outside this source directory. Depends how we imagine future path configuration would look.

This comment has been minimized.

Copy link
@evedon

evedon Sep 10, 2019

Contributor

SysTimer.h is included by mbed_os_timer.cpp & mbed_os_timer.cpp - both in platform so no problem at all to move to platform/source

mbed_os_timer.h is not included by any public header but by a few source files in rtos and platform. I would move it under platform/source for now but indeed, we might have to consolidate platform & rtos in the future or decide if headers accessed by different source directories should be moved to internal

This comment has been minimized.

Copy link
@kjbracey-arm

kjbracey-arm Sep 10, 2019

Contributor

I thought I saw one reference over in events.

If this was Yotta, then cross-component API would have to be in platform/internal, but we can figure out if we need that restriction later as you say.

@@ -31,6 +31,12 @@
extern "C" {
#endif

/**

This comment has been minimized.

Copy link
@kjbracey-arm

kjbracey-arm Sep 10, 2019

Contributor

This is all implementation, so shouldn't need any Doxygen marking, I think. It's implementing stuff declared in "mbed_atomic.h", which should have Doxygen bits.

@0xc0170 0xc0170 added needs: work and removed needs: review labels Sep 10, 2019
@evedon

This comment has been minimized.

Copy link
Contributor

commented Sep 10, 2019

Doxygen is missing from mbed_os_timer.h. It would be useful to add.

As per Kevin's comment, mbed_os_timer.h will be moved to source so we do not have to add doxygen.

@gpsimenos gpsimenos force-pushed the gpsimenos:gp-move-source-files branch from c3c84c0 to adfc68f Sep 10, 2019
@gpsimenos

This comment has been minimized.

Copy link
Contributor Author

commented Sep 10, 2019

This force push addresses above comments. SysTimer.h and mbed_os_timer.h moved to source, Doxygen removed from mbed_os_timer.h and mbed_atomic_impl.h.

@evedon
evedon approved these changes Sep 10, 2019
Copy link
Contributor

left a comment

As noted, we'll have to revisit later if platform/source/mbed_os_timer.h should move to platform/internal

@evedon

This comment has been minimized.

Copy link
Contributor

commented Sep 10, 2019

@0xc0170 This should go in 5.14

@0xc0170

This comment has been minimized.

Copy link
Member

commented Sep 10, 2019

@0xc0170 This should go in 5.14

5.14.0 to be specific? I tagged it to 5.14.0-rc2 , cc @adbridge

@gpsimenos gpsimenos force-pushed the gpsimenos:gp-move-source-files branch from 7286c5d to bd95c53 Sep 10, 2019
@gpsimenos

This comment has been minimized.

Copy link
Contributor Author

commented Sep 10, 2019

This force push to update absolute paths to the new locations

@adbridge

This comment has been minimized.

Copy link
Contributor

commented Sep 10, 2019

@gpsimenos @evedon Do we assume the force push has addressed all the review comments ?
@kjbracey-arm could you re-review please ?

@adbridge adbridge added the risk: A label Sep 10, 2019
@gpsimenos

This comment has been minimized.

Copy link
Contributor Author

commented Sep 10, 2019

@gpsimenos @evedon Do we assume the force push has addressed all the review comments ?
@kjbracey-arm could you re-review please ?

I believe I have addressed everything.

@adbridge adbridge removed the needs: work label Sep 10, 2019
@evedon

This comment has been minimized.

Copy link
Contributor

commented Sep 10, 2019

The review comments have been addressed and the last commit is fixing absolute paths in greentea tests.

@0xc0170

This comment has been minimized.

Copy link
Member

commented Sep 10, 2019

CI started

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Sep 10, 2019
@mbed-ci

This comment has been minimized.

Copy link

commented Sep 10, 2019

Test run: SUCCESS

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

@0xc0170 0xc0170 added ready for merge and removed needs: CI labels Sep 11, 2019
@0xc0170 0xc0170 merged commit 5e69377 into ARMmbed:master Sep 11, 2019
25 checks passed
25 checks passed
continuous-integration/jenkins/pr-head This commit looks good
Details
jenkins-ci/build-ARM Success
Details
jenkins-ci/build-GCC_ARM Success
Details
jenkins-ci/build-IAR Success
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/dynamic-memory-usage RTOS ROM(+0 bytes) RAM(+0 bytes)
Details
jenkins-ci/exporter Success
Details
jenkins-ci/greentea-test Success
Details
jenkins-ci/mbed2-build-ARM Success
Details
jenkins-ci/mbed2-build-GCC_ARM Success
Details
jenkins-ci/mbed2-build-IAR Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Success!
Details
travis-ci/docs Success!
Details
travis-ci/doxy-spellcheck Success!
Details
travis-ci/events Success! Runtime is 8647 cycles.
Details
travis-ci/gitattributestest Success!
Details
travis-ci/include_check Success!
Details
travis-ci/licence_check Success!
Details
travis-ci/littlefs Success! Code size is 8464B.
Details
travis-ci/psa-autogen Success!
Details
travis-ci/tools-py2.7 Success!
Details
travis-ci/tools-py3.5 Success!
Details
travis-ci/tools-py3.6 Success!
Details
travis-ci/tools-py3.7 Success!
Details
@adbridge adbridge removed the risk: A label Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.