doc(CONTRIBUTING): update #19891

- add section for managing includes via IWYU
- recommend clangd over ctags
- tidy up links
- remove ./scripts/check-includes.py

CONTRIBUTING.md

@@ -219,10 +219,10 @@ You can lint a single file (but this will _not_ exclude legacy errors):
 ### Style
 
 - You can format files by using:
-```
+  ```
-  make format
+    make format
-```
+  ```
-This will format changed Lua and C files with all appropriate flags set.
+  This will format changed Lua and C files with all appropriate flags set.
 - Style rules are (mostly) defined by `src/uncrustify.cfg` which tries to match
   the [style-guide]. To use the Nvim `gq` command with `uncrustify`:
   ```
@@ -245,15 +245,26 @@ This will format changed Lua and C files with all appropriate flags set.
   ```
   git config blame.ignoreRevsFile .git-blame-ignore-revs
   ```
-- Use **[universal-ctags](https://github.com/universal-ctags/ctags).**
+
-  ("Exuberant ctags", the typical `ctags` binary provided by your distro, is
+- Recommendation is to use **[clangd]**.
-  unmaintained and won't recognize many function signatures in Neovim source.)
+  Can use the maintained config in [nvim-lspconfig/clangd].
 - Explore the source code [on the web](https://sourcegraph.com/github.com/neovim/neovim).
-- If using [lua-language-server][], symlink `contrib/luarc.json` into the
+- If using [lua-language-server], symlink `contrib/luarc.json` into the
   project root:
 
       $ ln -s contrib/luarc.json .luarc.json
 
+### Includes
+
+For managing includes in C files, use [include-what-you-use].
+
+- [Install include-what-you-use][include-what-you-use-install]
+- Run with:
+  ```
+  make CMAKE_EXTRA_FLAGS=-DCMAKE_C_INCLUDE_WHAT_YOU_USE=include-what-you-use | tee iwyu.txt
+  ```
+
+See [#549][549] for more details.
 
 Reviewing
 ---------
@@ -271,30 +282,35 @@ commits in the feature branch which aren't in the `master` branch; `-p`
 shows each commit's diff. To show the whole surrounding function of a change
 as context, use the `-W` argument as well.
 
+[549]: https://github.com/neovim/neovim/issues/549
+[1820]: https://github.com/neovim/neovim/pull/1820
+[3174]: https://github.com/neovim/neovim/issues/3174
+[ASan]: http://clang.llvm.org/docs/AddressSanitizer.html
+[Clang report]: https://neovim.io/doc/reports/clang/
+[GitHub Actions]: https://github.com/neovim/neovim/actions
+[clangd]: https://clangd.llvm.org
+[Merge a Vim patch]: https://github.com/neovim/neovim/wiki/Merging-patches-from-upstream-Vim
+[complexity:low]: https://github.com/neovim/neovim/issues?q=is%3Aopen+is%3Aissue+label%3Acomplexity%3Alow
+[conventional_commits]: https://www.conventionalcommits.org
 [gcc-warnings]: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
+[gh]: https://cli.github.com/
 [git-bisect]: http://git-scm.com/book/en/v2/Git-Tools-Debugging-with-Git
 [git-feature-branch]: https://www.atlassian.com/git/tutorials/comparing-workflows
 [git-history-filtering]: https://www.atlassian.com/git/tutorials/git-log/filtering-the-commit-history
 [git-history-rewriting]: http://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
 [git-rebasing]: http://git-scm.com/book/en/v2/Git-Branching-Rebasing
 [github-issues]: https://github.com/neovim/neovim/issues
-[1820]: https://github.com/neovim/neovim/pull/1820
+[include-what-you-use-install]: https://github.com/include-what-you-use/include-what-you-use#how-to-install
-[gh]: https://cli.github.com/
+[include-what-you-use]: https://github.com/include-what-you-use/include-what-you-use#using-with-cmake
-[conventional_commits]: https://www.conventionalcommits.org
+[lua-language-server]: https://github.com/sumneko/lua-language-server/
-[style-guide]: https://neovim.io/doc/user/dev_style.html#dev-style
-[ASan]: http://clang.llvm.org/docs/AddressSanitizer.html
-[run-tests]: https://github.com/neovim/neovim/blob/master/test/README.md#running-tests
-[wiki-faq]: https://github.com/neovim/neovim/wiki/FAQ
-[review-checklist]: https://github.com/neovim/neovim/wiki/Code-review-checklist
-[3174]: https://github.com/neovim/neovim/issues/3174
-[sourcehut]: https://builds.sr.ht/~jmk
-[GitHub Actions]: https://github.com/neovim/neovim/actions
-[Merge a Vim patch]: https://github.com/neovim/neovim/wiki/Merging-patches-from-upstream-Vim
-[Clang report]: https://neovim.io/doc/reports/clang/
-[complexity:low]: https://github.com/neovim/neovim/issues?q=is%3Aopen+is%3Aissue+label%3Acomplexity%3Alow
 [master error list]: https://raw.githubusercontent.com/neovim/doc/gh-pages/reports/clint/errors.json
-[wiki-contribute-help]: https://github.com/neovim/neovim/wiki/contribute-%3Ahelp
+[nvim-lspconfig/clangd]: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#clangd
 [pr-draft]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
 [pr-ready]: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request
+[review-checklist]: https://github.com/neovim/neovim/wiki/Code-review-checklist
+[run-tests]: https://github.com/neovim/neovim/blob/master/test/README.md#running-tests
+[sourcehut]: https://builds.sr.ht/~jmk
+[style-guide]: https://neovim.io/doc/user/dev_style.html#dev-style
 [uncrustify]: http://uncrustify.sourceforge.net/
-[lua-language-server]: https://github.com/sumneko/lua-language-server/
+[wiki-contribute-help]: https://github.com/neovim/neovim/wiki/contribute-%3Ahelp
+[wiki-faq]: https://github.com/neovim/neovim/wiki/FAQ

scripts/check-includes.py

@@ -1,64 +0,0 @@
-#!/usr/bin/env python
-
-import sys
-import re
-import os
-
-from subprocess import Popen, PIPE
-from argparse import ArgumentParser
-
-
-GENERATED_INCLUDE_RE = re.compile(
-    r'^\s*#\s*include\s*"([/a-z_0-9.]+\.generated\.h)"(\s+//.*)?$')
-
-
-def main(argv):
-    argparser = ArgumentParser()
-    argparser.add_argument('--generated-includes-dir', action='append',
-                           help='Directory where generated includes are located.')
-    argparser.add_argument('--file', type=open, help='File to check.')
-    argparser.add_argument('iwyu_args', nargs='*',
-                           help='IWYU arguments, must go after --.')
-    args = argparser.parse_args(argv)
-
-    with args.file:
-        iwyu = Popen(['include-what-you-use', '-xc'] + args.iwyu_args + ['/dev/stdin'],
-                     stdin=PIPE, stdout=PIPE, stderr=PIPE)
-
-        for line in args.file:
-            match = GENERATED_INCLUDE_RE.match(line)
-            if match:
-                for d in args.generated_includes_dir:
-                    try:
-                        f = open(os.path.join(d, match.group(1)))
-                    except IOError:
-                        continue
-                    else:
-                        with f:
-                            for generated_line in f:
-                                iwyu.stdin.write(generated_line)
-                            break
-                else:
-                    raise IOError('Failed to find {0}'.format(match.group(1)))
-            else:
-                iwyu.stdin.write(line)
-
-    iwyu.stdin.close()
-
-    out = iwyu.stdout.read()
-    err = iwyu.stderr.read()
-
-    ret = iwyu.wait()
-
-    if ret != 2:
-        print('IWYU failed with exit code {0}:'.format(ret))
-        print('{0} stdout {0}'.format('=' * ((80 - len(' stdout ')) // 2)))
-        print(out)
-        print('{0} stderr {0}'.format('=' * ((80 - len(' stderr ')) // 2)))
-        print(err)
-        return 1
-    return 0
-
-
-if __name__ == '__main__':
-    raise SystemExit(main(sys.argv[1:]))