Skip to content

Commit

Permalink
Merge branch 'gz-cmake4' into merge_4_main_20241009
Browse files Browse the repository at this point in the history
  • Loading branch information
caguero committed Oct 9, 2024
2 parents 81e26ca + 6e202b7 commit d3e59b9
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ include(GzCMake)

#--------------------------------------
# Set up the project
gz_configure_project(VERSION_SUFFIX pre1)
gz_configure_project(VERSION_SUFFIX)

#--------------------------------------
# Set project-specific options
Expand Down
7 changes: 6 additions & 1 deletion Changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
## Gazebo CMake 4.x

### Gazebo CMake 4.0.0 (2024-09-24)
### Gazebo CMake 4.0.0 (2024-09-25)

1. Miscellaneous documentation fixes
* [Pull request #433](https://github.com/gazebosim/gz-cmake/pull/433)
* [Pull request #449](https://github.com/gazebosim/gz-cmake/pull/449)
* [Pull request #452](https://github.com/gazebosim/gz-cmake/pull/452)

1. Use relative paths for pkg-config install directory
* [Pull request #443](https://github.com/gazebosim/gz-cmake/pull/443)
Expand Down
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/ico

[Folder Structure](#folder-structure)

[Code of Conduct](#code-of-conduct)
[Contributing](#contributing)

[Contributing](#code-of-contributing)
[Code of Conduct](#code-of-conduct)

[Versioning](#versioning)

[License](#license)

# Features

gz-cmake provides a set of cmake modules that are used by the C++-based Gazebo projects. These modules help to control the quality and consistency of the Gazebo projects' build systems.
gz-cmake provides a set of cmake modules that are used by the C++ based Gazebo projects. These modules help to control the quality and consistency of the Gazebo projects build systems.

These modules are tailored to the Gazebo projects, so their use for non-Gazebo projects might be limited, but they may serve as a useful reference for setting up a modern cmake build system using good practices.

Expand Down Expand Up @@ -94,12 +94,14 @@ Replace `/path/to/install/dir` to whatever directory you want to install this pa
# Usage

Documentation can be accessed at https://gazebosim.org/libs/cmake
[Examples](examples/) are available in this repository.
[Tutorials](tutorials/) are also available in this repository.

[Examples](https://github.com/gazebosim/gz-cmake/tree/gz-cmake4/examples) are available in this repository.

[Tutorials](https://github.com/gazebosim/gz-cmake/tree/gz-cmake4/tutorials) are also available in this repository.

# Documentation

Documentation for `gz-cmake` can be found within the source code, and also in the [MIGRATION.md guide](https://github.com/gazebosim/gz-cmake/blob/master/MIGRATION.md).
Documentation for `gz-cmake` can be found within the source code, and also in the [MIGRATION.md guide](https://github.com/gazebosim/gz-cmake/blob/gz-cmake4/Migration.md).

# Testing

Expand All @@ -124,8 +126,8 @@ $ make test

# Contributing

Please see
[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).
Please see the
[contribution guide](https://gazebosim.org/docs/all/contributing).

# Code of Conduct

Expand Down
4 changes: 2 additions & 2 deletions tutorials/developing_with_gz-cmake.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ To change the build system type, set the CMake flag:
### Build sanitizers

`GZ_SANITIZER` CMake parameter can be used with different compilers to support the detection of different problems in the code.
[Check the documentation for `GZ_SANITIZER` flag](gz_cmake_sanitizers.md)
[Check the documentation for `GZ_SANITIZER` flag](https://gazebosim.org/api/cmake/4/sanitizersbuilds.html)

### Using CCache

Expand Down Expand Up @@ -134,7 +134,7 @@ To disable building documentation, set the CMake flag:

### Enabling/Disabling Tests

If your intent is to only produce libraries and executables, it is possible to disables tests.
If your intent is to only produce libraries and executables, it is possible to disable tests.

By default, building tests is *enabled*.

Expand Down

0 comments on commit d3e59b9

Please sign in to comment.