mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2024-11-30 17:21:10 +00:00
9b55bc4d11
Summary:
.clangd/index was well-intentioned in 2754942cba, but `.clangd` is the best
filename for the clangd config file (matching .clang-format and .clang-tidy).
And of course we can't have both .clangd/index and .clangd...
There are a few overlapping goals to satisfy:
- it should be clear from the directory name that this is transient
data that is safe to delete at the cost of recomputation, i.e. a cache
- it should be easy and self-documenting to blacklist these files in .gitignore
- we should have some consistency between filenames in-tree and
corresponding files in user storage (e.g. under XDG's ~/.cache/)
- we should be consistent across platforms (including windows, which
doesn't have distinct cache vs config directories)
So the plan is:
$PROJECT/.clangd (project config)
$PROJECT/.cache/clangd/index/ (project index)
$PROJECT/.cache/clangd/modules/ (maybe in future)
$XDG_CONFIG_HOME/clangd/config.yaml (user config)
$XDG_CACHE_HOME/clangd/index/ (index of non-project files)
$XDG_CACHE_HOME/clangd/modules/ (maybe in future)
This is sensible if XDG_{CONFIG,CACHE}_HOME coincide, and has a simple
.gitignore rule going forward: `.cache/`.
The monorepo gitignore is updated to reflect the backwards-compatible practice:
ignore .clangd/ (with trailing slash) matching index files from clangd 9/10
ignore .cache matching index from clangd 11+, and potentially other tools.
The entries from llvm-project/llvm gitignore are removed (obsolete).
Reviewers: kadircet, hokein
Subscribers: ilya-biryukov, MaskRay, jkorous, omtcyfz, arphaman, usaxena95, cfe-commits, llvm-commits
Tags: #clang, #llvm
Differential Revision: https://reviews.llvm.org/D83099
64 lines
1.9 KiB
Plaintext
64 lines
1.9 KiB
Plaintext
#==============================================================================#
|
|
# This file specifies intentionally untracked files that git should ignore.
|
|
# See: http://www.kernel.org/pub/software/scm/git/docs/gitignore.html
|
|
#
|
|
# This file is intentionally different from the output of `git svn show-ignore`,
|
|
# as most of those are useless.
|
|
#==============================================================================#
|
|
|
|
#==============================================================================#
|
|
# File extensions to be ignored anywhere in the tree.
|
|
#==============================================================================#
|
|
# Temp files created by most text editors.
|
|
*~
|
|
# Merge files created by git.
|
|
*.orig
|
|
# Byte compiled python modules.
|
|
*.pyc
|
|
# vim swap files
|
|
.*.sw?
|
|
.sw?
|
|
#OS X specific files.
|
|
.DS_store
|
|
|
|
# Nested build directory
|
|
/build*
|
|
|
|
#==============================================================================#
|
|
# Explicit files to ignore (only matches one).
|
|
#==============================================================================#
|
|
# Various tag programs
|
|
/tags
|
|
/TAGS
|
|
/GPATH
|
|
/GRTAGS
|
|
/GSYMS
|
|
/GTAGS
|
|
/ID
|
|
.gitusers
|
|
autom4te.cache
|
|
cscope.files
|
|
cscope.out
|
|
autoconf/aclocal.m4
|
|
autoconf/autom4te.cache
|
|
/compile_commands.json
|
|
# Visual Studio built-in CMake configuration
|
|
/CMakeSettings.json
|
|
# CLion project configuration
|
|
/.idea
|
|
|
|
#==============================================================================#
|
|
# Directories to ignore (do not add trailing '/'s, they skip symlinks).
|
|
#==============================================================================#
|
|
# VS2017 and VSCode config files.
|
|
.vscode
|
|
.vs
|
|
# clangd index. (".clangd" is a config file now, thus trailing slash)
|
|
.clangd/
|
|
.cache
|
|
# static analyzer regression testing project files
|
|
/clang/utils/analyzer/projects/*/CachedSource
|
|
/clang/utils/analyzer/projects/*/PatchedSource
|
|
/clang/utils/analyzer/projects/*/ScanBuildResults
|
|
/clang/utils/analyzer/projects/*/RefScanBuildResults
|