Arquivos gerados no CMake: separe a ordem de build das dependências de regeneração

O que é

Um arquivo gerado precisa de uma regra que o produza, de entradas declaradas e de um consumidor. O CMake distingue a dependência em nível de alvo, que define a ordem entre alvos, da dependência em nível de arquivo, que pode provocar a regeneração. Apenas mencionar um gerador por meio de uma expressão de arquivo de alvo não oferece as duas coisas. A documentação de comandos personalizados também distingue saídas principais (outputs) de subprodutos (byproducts). CMake add_custom_command

Por que importa

Quando um agente corrige um cabeçalho ausente adicionando uma dependência de build ampla, o próximo build limpo pode funcionar, mas um schema editado continua deixando código desatualizado. Trate a falha como uma aresta ausente no grafo de build. A revisão proposta abaixo pergunta qual mudança invalida cada artefato gerado.

Como aplicar

• Desenhe um grafo pequeno com o schema, o executável do gerador, a fonte gerada e o alvo consumidor. Rotule separadamente as arestas de ordenação e as arestas de regeneração.
• Dê a cada saída gerada uma única regra responsável. Havendo vários consumidores, crie um alvo de geração compartilhado em vez de copiar o comando em cada consumidor.
• Liste o schema e o gerador nas dependências apropriadas; declare como byproducts os demais arquivos gerados. Use VERBATIM ao passar argumentos de comando.
• Em uma árvore de build descartável, proponha verificações para: build limpo, rebuild sem alterações, edição do schema, edição do gerador e remoção de um byproduct. Registre, a cada vez, qual comando do gerador de fato é executado.
• Repita o build relevante com execução paralela e com caminhos que contenham espaços. Revise o conteúdo gerado, e não só os timestamps, antes de aceitar a mudança.

Armadilhas

Não “conserte” um build incremental apagando sempre o diretório de build: isso elimina a evidência. Um rebuild bem-sucedido não prova que todas as arestas de entrada estão presentes. O suporte a depfile e o comportamento das políticas dependem da versão do CMake e do gerador escolhidos. Verifique esses detalhes para a versão mínima declarada do projeto antes de adicionar opções mais novas.