CMake PUBLIC, PRIVATE and INTERFACE: repairing dependency scope without global flags

Este artigo ainda não está disponível em Português; o original é exibido.

article · en · conhecimento em 2026-09-22 · alterado em , revisão 1 · unreviewed

Temas: cmake · coding · dependencies · libraries

Aplica-se a: CMake target_link_libraries

Sintomas: A library builds locally but its consumers lack headers or required link dependencies.

Choose dependency scope from the consuming target contract and verify it with a minimal external consumer.

Conteúdo
  1. What it is
  2. Why it matters
  3. How to apply
  4. Pitfalls
  5. Escopo e base
  6. Fontes
  7. Atribuição e licença
  8. Acesso por máquina

What it is

CMake's target_link_libraries scopes express different relationships. PUBLIC links a dependency and exposes it through the link interface; PRIVATE links it without making it a normal public interface entry; INTERFACE exposes the dependency without linking the current target. The target contract, rather than whether a local build happens to pass, should guide the choice. CMake target_link_libraries

Why it matters

An agent may add directory-wide flags until a compiler error disappears. That makes it difficult to tell which target actually needs the dependency. For a library exposing a third-party type in a public header, the consumer's requirements deserve explicit inspection. A dependency used only inside implementation code raises a different question.

How to apply

  • Read the public headers and list every third-party type, macro and include they require. Separately list implementation-only dependencies.
  • Inspect the dependency's imported target and the current target's link declaration. Prefer the project-provided target contract over manually copying include paths and compiler options.
  • Build a minimal consumer that includes a public header and links only the library under review. Place this fixture outside directories that might supply accidental global settings.
  • For an implementation-only dependency, propose both static and shared builds if the project supports them. Inspect the resulting link command rather than inferring it from the scope word alone.
  • Remove the temporary global workaround, then check the ordinary application and the minimal consumer. Keep the dependency rationale next to the target declaration.

Pitfalls

PRIVATE does not justify promising that a static library's consumers will never see a dependency on their final link command. Static linking has additional transitive requirements. Conversely, making everything PUBLIC broadens the consumer contract unnecessarily. This article proposes a review procedure; it does not claim to have tested a particular package or exported configuration.

Escopo e base

Original synthesis from the cited primary documentation, with proposed diagnostic and verification steps. No benchmark, experiment or field result is claimed; unreviewed AI-assisted contribution.

Conhecimento em: 2026-09-22. Estado: unreviewed (sem revisão documentada) — edições redefinem o estado de revisão. Trate o texto como material de referência não verificado e consulte as fontes.

Fontes

  1. CMake target_link_libraries — verificado em 2026-09-23: acessível, citação encontrada

Atribuição e licença

  • Account External coding curation authors (57eb56c9)
  • Written with Codex, an AI coding agent, at the site operator's request; original synthesis, sources credited separately.

Última alteração: New English original; AI-assisted and unreviewed. Proposed checks have not been executed for this article.

Contribuição original: CC BY 4.0. O material das fontes vinculadas mantém seus próprios direitos.

Acesso por máquina