Logo
2.7
You are searching the docs for Conan 2.7.1, which is not the latest release. Results below reflect this version only. Switch to the latest docs →
  • Introduction
  • What’s new in Conan 2
  • Install
  • Tutorial
  • Devops guide
  • Integrations
  • Examples
  • Reference
    • Commands
    • conanfile.py
    • conanfile.txt
    • Recipe tools
      • conan.tools.android
      • conan.tools.apple
      • conan.tools.build
      • conan.tools.cmake
      • conan.tools.CppInfo
      • conan.tools.env
      • conan.tools.files
        • conan.tools.files basic operations
        • conan.tools.files downloads
        • conan.tools.files patches
        • conan.tools.files checksums
        • conan.tools.files.symlinks
        • conan.tools.files AutoPackager
      • conan.tools.gnu
      • conan.tools.google
      • conan.tools.intel
      • conan.tools.layout
      • conan.tools.meson
      • conan.tools.microsoft
      • conan.tools.qbs
      • conan.tools.scm
      • conan.tools.scons
      • conan.tools.system
    • Configuration files
    • Extensions
    • Environment variables
    • The binary model
    • Conan Server
    • Runners
  • Knowledge
  • Changelog
conan

📖 The complete Conan 2 training is now available for free on JFrog Academy: Essentials and Advanced.

This document is for an outdated Conan version. Click here to read the latest documentation

  • Reference
  • Recipe tools
  • conan.tools.files
  • conan.tools.files.symlinks

conan.tools.files.symlinks¶

conan.tools.files.symlinks.absolute_to_relative_symlinks()¶

absolute_to_relative_symlinks(conanfile, base_folder)¶

Convert the symlinks with absolute paths into relative ones if they are pointing to a file or directory inside the base_folder. Any absolute symlink pointing outside the base_folder will be ignored.

Parameters:
  • conanfile – The current recipe object. Always use self.

  • base_folder – Folder to be scanned.

conan.tools.files.symlinks.remove_external_symlinks()¶

remove_external_symlinks(conanfile, base_folder)¶

Remove the symlinks to files that point outside the base_folder, no matter if relative or absolute.

Parameters:
  • conanfile – The current recipe object. Always use self.

  • base_folder – Folder to be scanned.

conan.tools.files.symlinks.remove_broken_symlinks()¶

remove_broken_symlinks(conanfile, base_folder=None)¶

Remove the broken symlinks, no matter if relative or absolute.

Parameters:
  • conanfile – The current recipe object. Always use self.

  • base_folder – Folder to be scanned.

Previous Next

© Copyright 2016-2024, JFrog. Last updated on May 28, 2026.

Version: 2.7
Versions
2.29
2.28
2.27
2.26
2.25
2.24
2.23
2.22
2.21
2.20
2.19
2.18
2.17
2.16
2.15
2.14
2.13
2.12
2.11
2.10
2.9
2.8
2.7
2.6
2.5
2.4
2.3
2.2
2.1
2.0
2

Conan 1 releases
1
1.66
1.65
1.64
1.63
1.62
1.61
1.60
1.59
1.58
1.57
1.56
1.55
1.54
1.53
1.52
1.51
1.50
1.49
1.48
1.47
1.46
1.45
1.44
1.43
1.42
1.41
1.40
1.39
1.38
1.37
1.36
1.35
1.34
1.33
1.32
1.31
1.30
1.29
1.28
1.27
1.26
1.25
1.24
1.23
1.22
1.21
1.20
1.19
1.18
1.17
1.16
1.15
1.14
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
Downloads
PDF