CMake: add readme #13551

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

Merged

hugueskamba merged 6 commits into ARMmbed:feature-cmake from 0xc0170:dev_cmake_readme

Sep 7, 2020

Contributor

0xc0170 commented Sep 4, 2020

Summary of changes

Adding readme - CMake status.

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

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

Reviewers

mergify bot added the release-version: feature branch label

ciarmcom requested a review from a team

September 4, 2020 13:00

Member

ciarmcom commented Sep 4, 2020

@0xc0170, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.

ciarmcom added the needs: review label

hugueskamba reviewed

View reviewed changes

Collaborator

hugueskamba left a comment

Suggestions:

Rename the file to README.md
Add a section about supported toolchains
Add a section about known bugs (awaiting for CMake release, Windows response file path issue, etc...)

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

cmake/Readme.md Outdated Show resolved Hide resolved

Contributor Author

0xc0170 commented Sep 7, 2020

Updated, all comments answred. I'll rebase (one commit adding readme) once this is approved, don't mind the commits and their messages for now.

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

Contributor Author

0xc0170 commented Sep 7, 2020

Updated, added steps how to build an app

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

Contributor Author

0xc0170 commented Sep 7, 2020

Updated, all fixed

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

0xc0170 force-pushed the dev_cmake_readme branch from 7a39265 to 5a80f1f Compare

September 7, 2020 11:57

0xc0170 requested a review from hugueskamba

September 7, 2020 11:59

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

0xc0170 force-pushed the dev_cmake_readme branch from 5f299f2 to 97e259d Compare

September 7, 2020 12:36

Contributor Author

0xc0170 commented Sep 7, 2020

I rebased, 1 commit now

0xc0170 force-pushed the dev_cmake_readme branch from 97e259d to e14497f Compare

September 7, 2020 12:42

Contributor Author

0xc0170 commented Sep 7, 2020

Added CMAKE_BUILD_TYPE to the readme

0xc0170 force-pushed the dev_cmake_readme branch from e14497f to a4cafb9 Compare

September 7, 2020 12:43

Contributor Author

0xc0170 commented Sep 7, 2020

Fixed a typo and squashed

hugueskamba previously approved these changes

View reviewed changes

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

mergify bot dismissed hugueskamba’s stale review

September 7, 2020 13:30

Pull request has been modified.

0xc0170 force-pushed the dev_cmake_readme branch 2 times, most recently from ba8588c to 43202bd Compare

September 7, 2020 14:14

hugueskamba previously approved these changes

View reviewed changes

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated

Comment on lines 53 to 55

+                  ```
+                  cmake .. -GNinja -DCMAKE_BUILD_TYPE=Develop && cmake --build .
+                  ```

Collaborator

hugueskamba Sep 7, 2020

Suggested change

      
                ```
          
                cmake .. -GNinja -DCMAKE_BUILD_TYPE=Develop && cmake --build .
          
                ```
          
            ``
          
            cmake .. -GNinja -DCMAKE_BUILD_TYPE=Develop && cmake --build .
          
            ``

There is a formatting issue related to the indentation, all three lines should be moved to the beginning.

Note: I removed one "`" because of formatting issues with this comment but you should obviously have three of them as expected.

Contributor Author

0xc0170 Sep 7, 2020

+1 ,fixed

hugueskamba dismissed their stale review

September 7, 2020 14:27

There is a formatting issue. See #13551 (comment)


          CMake: add Readme - how to build and the current state of art

5b480d7

0xc0170 force-pushed the dev_cmake_readme branch from 43202bd to 5b480d7 Compare

September 7, 2020 14:30

hugueskamba reviewed

View reviewed changes

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

cmake/README.md Outdated Show resolved Hide resolved

0xc0170 and others added 5 commits

September 7, 2020 15:50


          Update cmake/README.md

4cb2009

Co-authored-by: Hugues Kamba <[email protected]>


          Update cmake/README.md

6addfbe

Co-authored-by: Hugues Kamba <[email protected]>


          Update cmake/README.md

50897db

Co-authored-by: Hugues Kamba <[email protected]>


          Update cmake/README.md

6bbb1bd

Co-authored-by: Hugues Kamba <[email protected]>


          Update cmake/README.md

705fa12

Co-authored-by: Hugues Kamba <[email protected]>

hugueskamba approved these changes

View reviewed changes

hugueskamba merged commit 8e34f86 into ARMmbed:feature-cmake

0xc0170 removed the needs: review label

0xc0170 deleted the dev_cmake_readme branch

September 7, 2020 15:18

hugueskamba pushed a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

0a4285c

hugueskamba pushed a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

104694b

0xc0170 added a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

9c498c1

hugueskamba pushed a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

46b7ca0

hugueskamba pushed a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

b78b451

0xc0170 added a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

5443df5

0xc0170 added a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

395ac4a

ladislas mentioned this pull request

CMake: Activate ccache #13824

Closed

0xc0170 added a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

ad7bf2b

hugueskamba pushed a commit that referenced this pull request


          CMake: Add information about the current state of support (#13551)

18cb55a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-version: feature branch