1797137 - Add recommendation to "Files: exclude" build directories in vscode docs

Status: RESOLVED FIXED

(Developer Infrastructure :: Developer Environment Integration, task)

Description

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

With the default set up, vscode does not exclude the build directories from the "Files: Exclude" and "Files: Watcher Exclude" preferences which has the following consequences:

• lengthened indexing time
• go to definition will go to headers in the objdir instead of the source tree
• go to file includes results from objdir
• search includes results in the build directories

See bug 1790517 for how we might do this in an automated fashion. In the mean time, since that issue doesn't appear to be making progress, I think we should document how devs can manually add these preferences in our vscode documentation.

Note: after adding the build directories to exclude, go-to-definition still works correctly for me for files only available in the objdir, like generated files.

Comment 1

[Kagami Rosylight [:saschanaz] (they/them)]

Also worth to say this is only for mercurial, as vscode automatically does this for git repositories.

Comment 2

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

Attachment: Bug 1797137 - document excluding build directories in VS Code. r=andi

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d29dbc982c8a
document excluding build directories in VS Code. r=andi DONTBUILD

Comment 4

[Marian-Vasile Laza]

https://hg.mozilla.org/mozilla-central/rev/d29dbc982c8a