llvm/llvm-project

clang-include-cleaner - replaces chrono with bits/chrono

Open

#68 213 ouverte le 4 oct. 2023

Voir sur GitHub
 (12 commentaires) (3 réactions) (0 assignés)C++ (10 782 forks)batch import
clang-include-cleanergood first issuehelp wanted

Métriques du dépôt

Stars
 (26 378 stars)
Métriques de merge PR
 (Merge moyen 1j 2h) (1 000 PRs mergées en 30 j)

Description

Issues found:

a)

+#include <bits/basic_string.h>
+#include <string>

b)

-#include <chrono>
+#include <bits/chrono.h>

Tested version from LLVM 17.0.2

misc-include-cleaner provide more information:

160   - DiagnosticName:  misc-include-cleaner
161     DiagnosticMessage:
162       Message:         'no header providing "std::operator""s" is directly included'
163       FilePath:        'some-file.cpp'
164       FileOffset:      982
165       Replacements:
166         - FilePath:        'some-file.cpp'
167           Offset:          52
168           Length:          0
169           ReplacementText: "#include <bits/basic_string.h>\n"

And:

304   - DiagnosticName:  misc-include-cleaner
305     DiagnosticMessage:
306       Message:         'no header providing "std::chrono::ceil" is directly included'
307       FilePath:        'some-file.cpp'
308       FileOffset:      3133
309       Replacements:
310         - FilePath:        'some-file.cpp'
311           Offset:          43
312           Length:          0
313           ReplacementText: "#include <bits/chrono.h>\n"

When <chrono> is already included.

Guide contributeur

Direction de recherche
Le problème signale que clang include cleaner suggère incorrectement de remplacer des en têtes standard comme <chrono> par des en têtes internes comme <bits/chrono.h>. Les diagnostics indiquent que le problème réside dans la logique de mappage des symboles vers les en têtes d'include cleaner. Examinez le code source de clang include cleaner (probablement sous clang tools extra/clang include cleaner/) pour comprendre comment les suggestions sont générées. Les commentaires dans l'issue peuvent fournir des informations sur le comportement attendu. Un correctif impliquerait de vérifier que l'en tête suggéré est un en tête public et non un en tête interne bits.
Stack technique
cpp
Domaine
developer experience
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C++Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75