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

Tutorial about developing with cmake and colcon #145

Merged
merged 6 commits into from
Jan 13, 2021

Conversation

mjcarroll
Copy link
Contributor

@mjcarroll mjcarroll commented Jan 12, 2021

Try to document a bit around useful CMake flags as well as interaction with colcon and how to speed up builds.

I'm open to relocating this if there is somewhere more useful.

Signed-off-by: Michael Carroll [email protected]

@mjcarroll mjcarroll requested a review from mxgrey as a code owner January 12, 2021 15:30
Base automatically changed from optionally_disable_docs to ign-cmake2 January 12, 2021 15:31
@mjcarroll mjcarroll force-pushed the developing_with_ign-cmake branch from 51fa1b6 to e812519 Compare January 12, 2021 15:32
@adlarkin adlarkin self-requested a review January 12, 2021 15:33
Signed-off-by: Michael Carroll <[email protected]>
@mjcarroll mjcarroll self-assigned this Jan 12, 2021
@azeey azeey self-requested a review January 12, 2021 16:08
Copy link
Contributor

@ahcorde ahcorde 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 include the tutorial in the tutorial.md.in file

mjcarroll and others added 2 commits January 12, 2021 11:53
Signed-off-by: Michael Carroll <[email protected]>

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Michael Carroll <[email protected]>
@mjcarroll
Copy link
Contributor Author

You should include the tutorial in the tutorial.md.in file

Done, thanks for catching that.

@mjcarroll mjcarroll requested a review from ahcorde January 12, 2021 18:00
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

LGTM

"-DCMAKE_CXX_COMPILER_LAUNCHER=ccache"
```

### Enabling/Disabling Documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

You could also have a section for BUILD_TESTING, and BUILDSYSTEM_TESTING

Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

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

Nice! Some of the tips were new to me. I just have some suggestions. I think this works well as a reference page.

tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
Copy link
Contributor

@adlarkin adlarkin left a comment

Choose a reason for hiding this comment

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

Mostly minor comments. This is very helpful, and I learned some new tricks I'll have to try out some time!

tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
tutorials/developing_with_ign-cmake.md Show resolved Hide resolved
mkdir -p ~/ign_edifice/src
cd ~/ign_edifice/
wget https://raw.githubusercontent.com/ignition-tooling/gazebodistro/master/collection-edifice.yaml
vcs import src < collection-edifice.yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

We should add a note about installing vcs in case users don't have this installed already.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have a note in the level 2 section that redirects to the ignition source installation documentation that should cover this, is that sufficient?

Copy link
Contributor

Choose a reason for hiding this comment

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

I had the same thought after I commented. Perhaps we can just mention users should go back to section 2 if they don't have vcs installed yet?

tutorials/developing_with_ign-cmake.md Outdated Show resolved Hide resolved
mjcarroll and others added 2 commits January 12, 2021 19:56
Co-authored-by: Louise Poubel <[email protected]>
Co-authored-by: Ashton Larkin <[email protected]>
Signed-off-by: Michael Carroll <[email protected]>
@mjcarroll mjcarroll merged commit 51a91db into ign-cmake2 Jan 13, 2021
@mjcarroll mjcarroll deleted the developing_with_ign-cmake branch January 13, 2021 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants