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

Restructure lwipstack directory #13371

Merged
merged 2 commits into from
Aug 5, 2020
Merged

Conversation

gpsimenos
Copy link
Contributor

Summary of changes

mbed-os/features/lwipstack directory restructured according to the internal proposal.

  • Public headers moved into mbed-os/connectivity/lwipstack/include/lwipstack folder
  • Source moved into mbed-os/connectivity/lwipstack/source folder

This is one of a series of PRs aiming to clean up the mbed-os directory structure. The intention is to create a consistent tree among mbed components, following the below structure:

[component name]
├── mbed_lib.json                     // Each component comes with their own config that's appended to the App/System ├── config 
├── CMakeList.txt                     // This depends on the build system choices, part of another PREQ
├── README.md
├── include                           // The top-level include path
│   └── [component name]              // Public headers that can be accessed by the developers - `#include [component name]/*.h`
│       └── internal                  // Internal headers that implement or are included by a public header or are needed by other Mbed OS libraries - `#include [component name]/internal/*.h`
├── source                            // Source files and private headers, available only inside the component's source directory
└── tests
    ├── <framework>                   // <framework> test folder (for example CPPUTEST)
    │   └── <test suite one>          // Can be either source file or a directory
    ├── UNITTESTS                     // Unit tests (previously in UNITTESTS) folder using googletest framework (to be renamed to gtest at a later stage)
    │   └── <unit test suite one>     // Can be either source file or a directory
    └── TESTS                         // Greentea tests (previously in TESTS) folder (to be renamed to greentea at a later stage)
        └── <greentea test suite one> // Can be either source file or a directory
 
mbed-os
└── TESTS (to be renamed to greentea at a later stage)
    ├── integration   
    └── system

Impact of changes

None

Migration actions required

None


Documentation

None


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

@evedon
@ashok-rao
@LDong-Arm


@ciarmcom ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label Jul 29, 2020
@ciarmcom ciarmcom requested review from ashok-rao, evedon, LDong-Arm and a team July 29, 2020 13:00
@ciarmcom
Copy link
Member

@gpsimenos, thank you for your changes.
@ashok-rao @evedon @LDong-Arm @ARMmbed/mbed-os-maintainers please review.

@LDong-Arm
Copy link
Contributor

I wonder if lwip and lwip-sys subdirectories should be moved into source. They are like internal libraries used by connectivity/lwipstack.

@gpsimenos
Copy link
Contributor Author

I wonder if lwip and lwip-sys subdirectories should be moved into source. They are like internal libraries used by connectivity/lwipstack.

Good shout. Moved those into source.

Copy link
Contributor

@0xc0170 0xc0170 left a comment

Choose a reason for hiding this comment

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

Commit 63d1f77 should contain details from the PR description

- Public headers moved into mbed-os/connectivity/lwipstack/include/lwipstack folder
- Source moved into mbed-os/connectivity/lwipstack/source folder
- Internal lwip and lwip-sys libraries moved to source folder
@mergify mergify bot dismissed 0xc0170’s stale review July 31, 2020 09:20

Pull request has been modified.

@gpsimenos
Copy link
Contributor Author

Rebased and reworded 63d1f77.

Copy link
Contributor

@LDong-Arm LDong-Arm left a comment

Choose a reason for hiding this comment

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

LGTM

@gpsimenos
Copy link
Contributor Author

Reverted previous commit moving lwip libraries inside source because that causes problems with the build system. The libraries must remain where they are for now.

@gpsimenos
Copy link
Contributor Author

Ping @0xc0170 @adbridge

@adbridge
Copy link
Contributor

adbridge commented Aug 4, 2020

CI started

@mergify mergify bot added needs: CI and removed needs: work labels Aug 4, 2020
@mbed-ci
Copy link

mbed-ci commented Aug 4, 2020

Test run: SUCCESS

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

@adbridge adbridge merged commit 1d362c8 into ARMmbed:master Aug 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants