It would be great to progressively start using IWYU where it works. This tool has some quirks, but we have to start somewhere and we can progressively improve things as we go.Thoughts?
--PK
You received this message because you are subscribed to the Google Groups "cxx" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cxx+uns...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAAHOzFB%2B53z_nw4UPxgEGf6YUiwEaeOWtE%2BrthftGFOHWaGCFA%40mail.gmail.com.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAN3LA9U9aLYPdQQFr7BjdvtK-RG-XwHHiQrvbq3SeL%2B_Tz8T8A%40mail.gmail.com.
The annotations seem to have no real cost to developers and help tools, they are not invasive and you dont have to worry about them unless you're trying to work on IWYU.I would be fine with adding the annotations, given we write something explaining about them and stick that in a doc in the tree.
On Wed, Oct 12, 2022 at 5:37 PM <dan...@chromium.org> wrote:The annotations seem to have no real cost to developers and help tools, they are not invasive and you dont have to worry about them unless you're trying to work on IWYU.I would be fine with adding the annotations, given we write something explaining about them and stick that in a doc in the tree.My concern would be any of the following three scenarios:
- We abandon work on IWYU or go a different route that stops using these annotations. The file becomes useless cruft in the tree, but no one removes it.
- Updating out-of-line annotations becomes a best practice for a variety of reasons, but no tooling exists to remind authors to do this or help them do it easily.
- The annotations are not sufficiently maintained in some way that results in tools (especially editor suggestions) making actively-incorrect recommendations, which is worse than no recommendations.
If we can make these scenarios reasonably unlikely, AND we believe that there is potential value in the current IWYU route (my perception is that google3 considers it a dead end), I would be OK with this.
PK
My concern would be any of the following three scenarios:
- We abandon work on IWYU or go a different route that stops using these annotations. The file becomes useless cruft in the tree, but no one removes it.
- Updating out-of-line annotations becomes a best practice for a variety of reasons, but no tooling exists to remind authors to do this or help them do it easily.
- The annotations are not sufficiently maintained in some way that results in tools (especially editor suggestions) making actively-incorrect recommendations, which is worse than no recommendations.
If we can make these scenarios reasonably unlikely, AND we believe that there is potential value in the current IWYU route (my perception is that google3 considers it a dead end), I would be OK with this.
PK
--
You received this message because you are subscribed to the Google Groups "cxx" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cxx+uns...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAN3LA9UH7f3XSjGSaik6a7otS1Bhd2TUaAD6Yv%2BgLi6W3CVsyQ%40mail.gmail.com.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAN3LA9W1pzFbRO%2BHh8OMGzcKd%2B%3DOQ06tobxNoFokXgOgXxjQSw%40mail.gmail.com.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAL0AKM9waU2339%3DU67GgZGC9ha1v23P_gmmLb4TuEcErEn3%3DCw%40mail.gmail.com.
- the preferred style if IWYU pragmas and nogncheck comments need to intersect. Similarly, the preferred style if IWYU pragmas and other explanatory comments on headers intersect
- should we prefer end-of-line comment style always due to the aforementioned clang-format header sorting behavior (e.g. no begin_exports/end_exports and just use export)
--
You received this message because you are subscribed to the Google Groups "cxx" group.
To unsubscribe from this group and stop receiving emails from it, send an email to cxx+uns...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAL0AKM99C%2BX%3DS-3RbHFEjBvDm2kbHueqqv-NfrmS_SQQ-8hK4Q%40mail.gmail.com.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAHtyhaSRWh4VMHmhkuNdQsemJPogyXg-G4KH9QqnkzFgLiFT_g%40mail.gmail.com.
TIL about https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html - it seems to be another tool that we may be able to use in the quest toward IWYU cleaniness?
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/cxx/CAA_NCUGxWw1icOq5LEsmS7HY0mDMiWwnuW8QeYcz3O0D%2BMiovA%40mail.gmail.com.