llvm / llvm/llvm-project

Update test checks for Clang-Doc

Open
#168,569 2 comments 0 reactions 0 assignees View on GitHub
clang-doc
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

UTC is a valuable utility for LLVM developers to update tests due to mechanical changes in codegen that affect a lot of tests.

Like those LLVM passes, changes to Clang-Doc's templates or core data structures often cause a lot of churn in our test output.

It would be best if we had a utility, like UTC that could update our test outputs in a maintainable way.

This could be done either by extending some of the functionality in the UTC scripts, or by writing our own version that reuses the UTC modules.

Contributor guide

Open the contributing guide

Research direction

Start by examining the existing UTC scripts and reusable UTC modules, then review how Clang-Doc tests record expected output. Compare extending UTC with creating a Clang-Doc-specific utility; done means maintainable test-output updates cover template or core data-structure changes without manual churn.

Written by the indexing model from the issue text.

Assessment

Domain
compilers, testing, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.