Project management

Aug

2023

How to list all tags of remote git repository using Python

import subprocess

def list_all_tags_for_remote_git_repo(url):
    """
    Given a repository URL, list all tags for that repository
    without cloning it.

    This function use "git ls-remote", so the
    "git" command line program must be available.
    """
    # Run the 'git' command to fetch and list remote tags
    result = subprocess.run([
        "git", "ls-remote", "--tags", repo_url
    ], stdout=subprocess.PIPE, text=True)

    # Process the output to extract tag names
    output_lines = result.stdout.splitlines()
    tags = [
        line.split("refs/tags/")[-1] for line in output_lines
        if "refs/tags/" in line and "^{}" not in line
    ]

    return tags

Usage example:

list_all_tags_for_remote_git_repo("https://github.com/EmbeddedRPC/erpc.git")

Result:

['1.10.0',
 '1.11.0',
 '1.4.0',
 '1.4.1',
 '1.5.0',
 '1.6.0',
 '1.7.0',
 '1.7.1',
 '1.7.2',
 '1.7.3',
 '1.7.4',
 '1.8.0',
 '1.8.1',
 '1.9.0',
 '1.9.1']

Jun

2023

How to fix CMake “Could not find a package configuration file provided by “Qt5Core” on Ubuntu?

Problem:

When trying to configure your project using e.g.

cmake .

you see the following error messages:

CMake Warning at CMakeLists.txt:120 (find_package):
  By not providing "FindQt5Core.cmake" in CMAKE_MODULE_PATH this project has
  asked CMake to find a package configuration file provided by "Qt5Core", but
  CMake did not find one.

  Could not find a package configuration file provided by "Qt5Core" with any
  of the following names:

    Qt5CoreConfig.cmake
    qt5core-config.cmake

  Add the installation prefix of "Qt5Core" to CMAKE_PREFIX_PATH or set
  "Qt5Core_DIR" to a directory containing one of the above files.  If
  "Qt5Core" provides a separate development package or SDK, be sure it has
  been installed.

Solution:

Install qtbase5-dev:

sudo apt -y install qtbase5-dev

Jun

2023

How to get dependency include & library directories in Conanfile.py

Within conanfile.py , this is how you can obtain a list of include & library directories for each of the dependencies:

class MyProject(Conanfile):
    # ...
    def build(self):
        # Check dependencies
        for dependency in self.dependencies.values():
            cppinfo = dependency.cpp_info.aggregated_components()
            print("libdirs", cppinfo.libdirs)
            print("includedirs", cppinfo.includedirs)
        # ...

Jun

2023

How to use ‘conan download’ to download a package from conancenter

When you try to download a package from conancenter using conan download, the right syntax to use is:

conan download libcurl/8.1.1 -r conancenter

If you forget to specify -r conancenter, you will see the following error message:

usage: conan download [-h] [-v [V]] [--only-recipe] [-p PACKAGE_QUERY] -r REMOTE reference
conan download: error: the following arguments are required: -r/--remote
ERROR: Exiting with code: 2

Jun

2023

How to fix conan ERROR: The default build profile doesn’t exist.

Problem:

You want to install or build a conan project using a command such as

conan install .

but you see an error message such as

ERROR: The default build profile '/home/uli/.conan2/profiles/default' doesn't exist.
You need to create a default profile (type 'conan profile detect' command)
or specify your own profile with '--profile:build=<myprofile>'

Solution:

Typically you just want to create the default build profile using

conan profile detect

detect means to detect the compiler.

Jun

2023

List of conan 2.x pre-defined templates

The following list of templates is predefined for conan 2.0.6:

basic
cmake_lib
cmake_exe
meson_lib
meson_exe
msbuild_lib
msbuild_exe
bazel_lib
bazel_exe
autotools_lib
autotools_exe

You can check for yourself using

conan new --help

In the output from this command, look for positional arguments -> template. In the help text, you’ll find a list of possible templates.

Jun

2023

How to fix conan new ERROR: Missing definitions for the template. Required definitions are: ‘name’, ‘version’

Problem:

You want to initialize your conan project using a command such as

conan new cmake_exe

but you see the following error message:

ERROR: Missing definitions for the template. Required definitions are: 'name', 'version'

Solution:

Conan wants you to specify the name and version of your package using -d name=myproject -d version=1.0.0.

Full example:

conan new cmake_exe -d name=MyPkg -d version=1.0.0

Jun

2023

How to fix conan ERROR: Template doesn’t exist or not a folder

Problem:

You want to initialize a conan project using a command such as

conan new myproject/1.0.0

However, once you run it, you see an error message like

ERROR: Template doesn't exist or not a folder: myproject/1.0.0

Solution:

The way you have to use conan new changed with Conan version 2.0.

Now you don’t specify the project name but a template! Templates are names such as cmake_exe but the easiest template to start with is basic as it doesn’t require any parameters:

conan new basic

You can also initialize it using a predefined template such as cmake_exe:

conan new cmake_exe -d name=MyProject -d version=1.0.0

Jun

2023

How to initialize C++ project using conan 2.x

The simplest way of starting is by running the following command in your project directory:

conan new basic

This will create conanfile.py from the basic template.

Alternatively, you can initialize it from a predefined template such as cmake_exe:

conan new cmake_exe -d name=myproject -d version=1.0.0

May

2023

How to configure CMake to use C++20

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

Apr

2023

How to fix SCons error: Do not know how to make File target `clean’

Problem:

You are trying to clean your SCons build using

scons clean

but you see the following error message:

scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets ...
scons: *** Do not know how to make File target `clean' (/home/user/myproject/clean).  Stop.
scons: building terminated because of errors.

Solution:

When using SCons, the correct command to clean is

scons --clean

Apr

2023

How to fix SCons not providing colored GCC/C++ output

You can force SCons to provide colored output when using GCC or G++ by adding

-fdiagnostics-color=always

to your CFLAGS or CXXFLAGS. Typically, my recommendation is to add it to both CFLAGS and CXXFLAGS.

Apr

2023

Minimal CMake .gitignore

# CMake generated files
build/
CMakeCache.txt
CMakeFiles/
Makefile
cmake_install.cmake
install_manifest.txt

Apr

2023

How to include current directory using CMake

It is often helpful to include the current directory for C++ projects. When using GCC directly, this can be done using -I., whereas for CMake you need to use the following statement:

target_include_directories(myexe PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

Remember to replace myexe by the name of your executable target.

Jan

2023

How to generate human-readable description of git commit

The following command assumes that you have at least one previous tag in the repository:

git describe --long --tags --dirty

Example output:

v0.1.0-9-g68066f4-dirty

This means that we’re on the 9th commit after the v0.1.0 tag with commit ID g68066f4 and the working tree is dirty, i.e. there are uncommited changes.

Dec

2022

How to specify which docker image to use in .gitlab-ci.yml

The following .gitlab-ci.yml will build a native executable project using cmake with a custom docker image:

stages:
  - build

buildmyexe:
  stage: build
  image: 'ulikoehler/ubuntu-gcc-cmake:latest'
  script:
    - cmake .
    - make -j4

In this example, we have only one stage – if you have multiple stages, you can specify different images for each of them.

Dec

2022

How to fix CMake Error: Cannot find source file: *.cpp

Problem:

You are trying to build your CMake-based project using a CMakeLists.txt like

cmake_minimum_required(VERSION 3.10)
project(my_project)

add_executable(my_project *.cpp)

Solution:

You can’t use the glob pattern *.cpp directly in add_executable(). You need to use file(GLOB ...) in order to set a variable, which you can then use in add_executable():

cmake_minimum_required(VERSION 3.10)
project(my_project)

file(GLOB SRC_FILES *.cpp)
add_executable(my_project ${SRC_FILES})

Dec

2022

How to git un-add (undo “git add” command) a file

git reset [filename]

will undo a previous git add [filename] call – one could say, it un-adds filename

Nov

2022

How to fix CMake “target_include_directories called with invalid arguments”

Problem:

In your CMakeLists.txt, you want to add an include directory such as /usr/include/mylibrary for the executable myexe using code like:

target_include_directories( myexe /usr/include/mylib )

But when you try to configure the build using cmake . or make, you see an error message like

CMake Error at CMakeLists.txt:8 (target_include_directories):
  target_include_directories called with invalid arguments


-- Configuring incomplete, errors occurred!

Solution:

You need to add PUBLIC between the target name (myexe) and the include directory/directories:

target_include_directories( myexe PUBLIC /usr/include/mylib )

Nov

2022

How to git submodule init & git submodule update in a single command

Instead of separately running

git submodule init
git submodule update

you can just

git submodule update --init

In many cases, you also want to git submodule update recursively using:

git submodule update --init --recursive

Project management

How to list all tags of remote git repository using Python

Usage example:

How to fix CMake “Could not find a package configuration file provided by “Qt5Core” on Ubuntu?

Problem:

Solution:

How to get dependency include & library directories in Conanfile.py

How to use ‘conan download’ to download a package from conancenter

How to fix conan ERROR: The default build profile doesn’t exist.

Problem:

Solution:

List of conan 2.x pre-defined templates

How to fix conan new ERROR: Missing definitions for the template. Required definitions are: ‘name’, ‘version’

Problem:

Solution:

How to fix conan ERROR: Template doesn’t exist or not a folder

Problem:

Solution:

How to initialize C++ project using conan 2.x

How to configure CMake to use C++20

How to fix SCons error: Do not know how to make File target `clean’

Problem:

Solution:

How to fix SCons not providing colored GCC/C++ output

Minimal CMake .gitignore

How to include current directory using CMake

How to generate human-readable description of git commit

How to specify which docker image to use in .gitlab-ci.yml

How to fix CMake Error: Cannot find source file: *.cpp

Problem:

Solution:

How to git un-add (undo “git add” command) a file

How to fix CMake “target_include_directories called with invalid arguments”

Problem:

Solution:

How to git submodule init & git submodule update in a single command

Search

Categories