From 2425121c0f946257365637ab806f49db033397e6 Mon Sep 17 00:00:00 2001 From: Antoine Van Malleghem Date: Tue, 3 Sep 2024 20:30:15 +0200 Subject: [PATCH 1/3] Fix readme issues (#449) Signed-off-by: Van Malleghem Antoine --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9f7d27b0..a60ed7c8 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ 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) @@ -45,7 +45,7 @@ Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/ico # 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. @@ -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 @@ -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 From 4a944f4a490773c8bb7e589b21e461e26b9efdb4 Mon Sep 17 00:00:00 2001 From: Antoine Van Malleghem Date: Fri, 6 Sep 2024 20:31:42 +0200 Subject: [PATCH 2/3] fix tutorial developing with gz-cmake (#452) Signed-off-by: Van Malleghem Antoine --- tutorials/developing_with_gz-cmake.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/developing_with_gz-cmake.md b/tutorials/developing_with_gz-cmake.md index 0bb36cb1..aa468d2a 100644 --- a/tutorials/developing_with_gz-cmake.md +++ b/tutorials/developing_with_gz-cmake.md @@ -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 @@ -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*. From 6e202b72e56bda3965d1efdf6edf8447cc1299cc Mon Sep 17 00:00:00 2001 From: "Addisu Z. Taddese" Date: Wed, 25 Sep 2024 17:52:35 -0500 Subject: [PATCH 3/3] Prepare for 4.0.0 (#453) Signed-off-by: Addisu Z. Taddese --- CMakeLists.txt | 2 +- Changelog.md | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 17944664..fc0e27ba 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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 diff --git a/Changelog.md b/Changelog.md index 4036f65d..edba78a6 100644 --- a/Changelog.md +++ b/Changelog.md @@ -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)