Ignore build files for VS and VS Code #105513

Jorijn de Graaf · 2023-03-07T00:18:56+01:00

Jorijn de Graaf commented

2023-03-07 00:18:56 +01:00

I like using these tools, but it's a bit tedious having to carefully avoid committing their build and config files.

Visual Studio:

The out folder is for build files.
The file CMakeSettings.json lets you configure your build, and has a handy UI in VS.
The file CMakeProperties.json does the same minus the UI, but is natively supported by CMake.

Visual Studio Code:

The folder build is for build files generated by the CMake Integration extension.

I like using these tools, but it's a bit tedious having to carefully avoid committing their build and config files. Visual Studio: - The out folder is for build files. - The file CMakeSettings.json lets you configure your build, and has a handy UI in VS. - The file CMakeProperties.json does the same minus the UI, but is natively supported by CMake. Visual Studio Code: - The folder build is for build files generated by the CMake Integration extension.

Jorijn de Graaf added 1 commit 2023-03-07 00:19:05 +01:00

Ignore build files for VS and VS Code ff910d48e9

I like using these tools, but it's a bit tedious having to carefully avoid committing their build and config files.

Visual Studio:
- The out folder is for build files.
- The file CMakeSettings.json lets you configure your build, and has a handy UI in VS.
- The file CMakeProperties.json does the same minus the UI, but is natively supported by CMake.
The file CppProperties.json is for configuring C/C++ related settings.

Visual Studio Code:
- The folder build is for build files.
- The file c_cpp_properties.json is for configuring C/C++ related settings.

Jorijn de Graaf commented

2023-03-07 00:21:50 +01:00

Maybe I should move CMakeProperties.json into its own section, because it's supported by CMake natively.
I'm fine with the current placement too though.

Maybe I should move CMakeProperties.json into its own section, because it's supported by CMake natively. I'm fine with the current placement too though.

Ray molenkamp requested review from Jacques Lucke 2023-03-07 02:48:34 +01:00

Ray molenkamp requested review from Ray molenkamp 2023-03-07 02:48:34 +01:00

Ray molenkamp commented

2023-03-07 02:49:19 +01:00

VS looks fine, i'd like to get @JacquesLucke opinion on the vscode additions though

Jorijn de Graaf commented

2023-03-07 03:22:37 +01:00

I'll need to double check where those C/C++ json files go actually, because if they go in a .vs* folder, there's no need the ignore them explicitly.

Ray molenkamp commented

2023-03-07 06:15:12 +01:00

I gave you the greenlight for a single VS related ignore, you submitted a patch with a whole bunch of other stuff in it, which I had to ask a second reviewer time for, and you're now not sure about some of it, I gotta admit, this was supposed to be a 1 line patch, approved and landed in under 5 minutes, it wasn't supposed to drag and feature creep like this

Jacques Lucke commented

2023-03-07 10:19:07 +01:00

My vscode config files are always in the .vscode which is ignore for me already. I never ran into the problem that vscode adds files to the repo. You should demonstrate how to reproduce how those files are added automatically.

My vscode config files are always in the `.vscode` which is ignore for me already. I never ran into the problem that vscode adds files to the repo. You should demonstrate how to reproduce how those files are added automatically.

Jorijn de Graaf commented

2023-03-07 14:13:40 +01:00

My vscode config files are always in the .vscode which is ignore for me already. I never ran into the problem that vscode adds files to the repo. You should demonstrate how to reproduce how those files are added automatically.

The build folder is created by the CMake Integration extension.
The CPP json file probably goes in the .vscode folder though, so I'll get rid of that one.
I assumed that the "workspace folder" in the VS/VSC docs would refer to like the folder you have open, but in hindsight it probably refers to the .vs* folder.

> My vscode config files are always in the `.vscode` which is ignore for me already. I never ran into the problem that vscode adds files to the repo. You should demonstrate how to reproduce how those files are added automatically. The build folder is created by the [CMake Integration extension](https://marketplace.visualstudio.com/items?itemName=go2sh.cmake-integration-vscode). The CPP json file probably goes in the .vscode folder though, so I'll get rid of that one. I assumed that the "workspace folder" in the VS/VSC docs would refer to like the folder you have open, but in hindsight it probably refers to the .vs* folder.

Jorijn de Graaf added 1 commit 2023-03-07 14:17:10 +01:00

Simplify VS/VSC gitignore f8bec91888

In hindsight I think the CPP related config files are generated in already ignored folders, so I guess those don't need to be here.
I've moved the remaining lines into one section together.

Jorijn de Graaf commented

2023-03-07 14:18:47 +01:00

I gave you the greenlight for a single VS related ignore, you submitted a patch with a whole bunch of other stuff in it, ...

In my issue I specified multiple things that needed to be gitignored.
I could make multiple PRs but I think it'd be silly.

> I gave you the greenlight for a single VS related ignore, you submitted a patch with a whole bunch of other stuff in it, ... In my issue I specified multiple things that needed to be gitignored. I could make multiple PRs but I think it'd be silly.

Jorijn de Graaf commented

2023-03-07 14:21:31 +01:00

Anyway I got rid of the CPP related json files now as they are probably not necessary; I suppose I misunderstood the documentation initially.
The remaining 4 lines are necessary though.

Anyway I got rid of the CPP related json files now as they are probably not necessary; I suppose I misunderstood the documentation initially. The remaining 4 lines are necessary though.

Jorijn de Graaf added 1 commit 2023-03-07 14:27:49 +01:00

Merge branch 'main' into ignore-vs-and-vsc-build-files f528c9bc8e

Germano Cavalcante commented

2023-03-07 15:49:36 +01:00

Ignoring CMakeSettings.json and CMakePresets.json looks fine. But I'm not sure about the ./out and ./build directories.

I'm not sure if it's a good practice to put the build files inside the repository whose files are affected by CMake.

Explicitly showing that we ignore these files seems to encourage the practice.

And for non experienced developers these directories can be created by VS without them being aware.

Ignoring `CMakeSettings.json` and `CMakePresets.json` looks fine. But I'm not sure about the `./out` and `./build` directories. I'm not sure if it's a good practice to put the build files inside the repository whose files are affected by CMake. Explicitly showing that we ignore these files seems to encourage the practice. And for non experienced developers these directories can be created by VS without them being aware.

Ray molenkamp commented

2023-03-07 16:09:08 +01:00

I'm not sure if it's a good practice to put the build files inside the repository whose files are affected by CMake.

VS is just bad in this regard, out of tree builds just aren't a concept they seem to grasp, this has been known for better part of a decade now and they seem unlikely to change their minds there, best we can do is minimize the damage of their bad practices, and ignores seem like a pretty good way to go about that.

Explicitly showing that we ignore these files seems to encourage the practice.

There's a fine distinction encouraging/supporting and allowing some niceties for people off the beaten path.

If people want to ignore our best practices for some reason that's fine, some of them will have good reasons, some of them perhaps not, who are we to judge? Either way people have to freedom to do whatever they like. It's one of the many things that makes opensource great. If adding a few ignores makes their environment just a smidge better, I see no reason not to do that, there are limitations though.....

Expecting us to fully support and document how you would configure the IDE for this setup and help people in the future that run into issues, is a whole different story and not something I'm willing to entertain, and also not something @bonj is pushing for here.

Also it can't interfere with any supported scenario's which it currently doesn't do, so yeah I have no issues with this.

Bit concerned about how much of my time this seemingly trivial diff is taking, but beyond that I'm a happy camper.

> I'm not sure if it's a good practice to put the build files inside the repository whose files are affected by CMake. VS is just bad in this regard, out of tree builds just aren't a concept they seem to grasp, this has been known for better part of a decade now and they seem unlikely to change their minds there, best we can do is minimize the damage of their bad practices, and ignores seem like a pretty good way to go about that. > Explicitly showing that we ignore these files seems to encourage the practice. There's a fine distinction encouraging/supporting and allowing some niceties for people off the beaten path. If people want to ignore our best practices for some reason that's fine, some of them will have good reasons, some of them perhaps not, who are we to judge? Either way people have to freedom to do whatever they like. It's one of the many things that makes opensource great. If adding a few ignores makes their environment just a smidge better, I see no reason not to do that, there are limitations though..... Expecting us to fully support and document how you would configure the IDE for this setup and help people in the future that run into issues, is a whole different story and not something I'm willing to entertain, and also not something @bonj is pushing for here. Also it can't interfere with any supported scenario's which it currently doesn't do, so yeah I have no issues with this. Bit concerned about how much of my time this seemingly trivial diff is taking, but beyond that I'm a happy camper.

Germano Cavalcante commented

2023-03-07 16:56:49 +01:00

I like using these tools, but it's a bit tedious having to carefully avoid committing their build and config files.

Why don't you list these files in /blender/.git/info/exclude?

You only configure it once and do not even have to touch blender/.gitignore

> I like using these tools, but it's a bit tedious having to carefully avoid committing their build and config files. Why don't you list these files in `/blender/.git/info/exclude`? You only configure it once and do not even have to touch `blender/.gitignore`

Jorijn de Graaf commented

2023-03-07 17:01:05 +01:00

Why don't you list these files in /blender/.git/info/exclude?

I'm not familiar with this technique, will have to try it out.
Still I think gitignore is a better solution, because that way it's setup for everyone, instead of needing to mention this in a guide somewhere.

> Why don't you list these files in `/blender/.git/info/exclude`? I'm not familiar with this technique, will have to try it out. Still I think gitignore is a better solution, because that way it's setup for everyone, instead of needing to mention this in a guide somewhere.

Ray molenkamp commented

2023-03-07 17:04:03 +01:00

Testing locally i'm only seeing an /out directory and and out/build folder, can you validate where your /build folder is coming from?

Testing locally i'm only seeing an `/out` directory and and `out/build` folder, can you validate where your `/build` folder is coming from?

Germano Cavalcante commented

2023-03-07 17:05:52 +01:00

Not I'm not really against it.
Just listed a few points of concern to balance.
But it doesn't really seem like something to worry about too much.

Not I'm not really against it. Just listed a few points of concern to balance. But it doesn't really seem like something to worry about too much.

Jorijn de Graaf commented

2023-03-07 17:09:06 +01:00

Testing locally i'm only seeing an /out directory and and out/build folder, can you validate where your /build folder is coming from?

It's not from VS but VS Code, specifically the CMake Integration extension.
I could make a separate PR for this if you prefer to keep this one just about VS.

> Testing locally i'm only seeing an `/out` directory and and `out/build` folder, can you validate where your `/build` folder is coming from? It's not from VS but VS Code, specifically the CMake Integration extension. I could make a separate PR for this if you prefer to keep this one just about VS.

Jorijn de Graaf commented

2023-03-07 17:14:33 +01:00

Bit concerned about how much of my time this seemingly trivial diff is taking, but beyond that I'm a happy camper.

I apologize for my incompetence, it will happen again.

> Bit concerned about how much of my time this seemingly trivial diff is taking, but beyond that I'm a happy camper. I apologize for my incompetence, it will happen again.

Ray molenkamp added 1 commit 2023-03-07 17:22:58 +01:00

Merge branch 'main' into ignore-vs-and-vsc-build-files 5873ca6c7f

Jorijn de Graaf added 1 commit 2023-03-07 17:24:26 +01:00

Add CMakeUserPresets.json to gitignore b28fdb99e3

https://learn.microsoft.com/en-us/cpp/build/cmake-presets-vs?view=msvc-170
CMakePresets.json is for project wide builds, CMakeUserPresets.json is for developers to save their own local builds.
I think it makes sense to ignore them both.

Jorijn de Graaf commented

2023-03-07 17:25:08 +01:00

Oh I didn't see you merged main just now. I hope my extra commit doesn't mess anything up.

Ray molenkamp merged commit 393d5aac59 into main

2023-03-07 17:38:46 +01:00

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Ignore build files for VS and VS Code #105513