doc: add tips about vcpkg cause build faild on windows

[congzhangzh]

vcpkg may cause nodejs build on windows to fail, symbol already defined in zlib.lib(zlib1.dll).

vcpkg uses some magic to hook into the vc++ project, add its include to include search dir and auto copy the dll to output dir if vcpkg integrate install is done.

some talk happens on the internet and none of them point to vcpkg, but one thing is sure, once you run vcpkg integrate remove, vcbuild.bat will succ!

vcpkg is popular and included in CLion and Visual Studio, so our folks should know this may be a trouble!

Refs:

1. Multiply defined symbol errors in libuv.lib and openssl.lib because of node.lib help#1656
2. Problem Building Node (had errors about multiply-defined symbols and such) #24448

[congzhangzh]

@H4ad Hi Vinicius, can you review this document?

[H4ad]

Since I never had this issue and I don't know how to reproduce it, I'm afraid that I should not approve this.

But let's ping the other members of @nodejs/platform-windows and see if someone feels more comfortable approving this one.

[StefanStojanovic]

@congzhangzh I'd like to check this, but I too never had this issue. Do you have any idea how to reproduce the issue this tip solves?

[congzhangzh]

@congzhangzh I'd like to check this, but I too never had this issue. Do you have any idea how to reproduce the issue this tip solves?

@StefanStojanovic Hi Stefan, that's great you can help:)

First, let me clarify how I identified this problem.

I have two windows to compile node, one work, and the other failed.
The failed one told me that symbol was redefined.
I use some trick to allow symbol redefine of link.exe, and build success with a warning! https://github.com/congzhangzh/daily-scripts-4-us/blob/38ff4ecefe19ef796a198a817aa7b773c715ae5e/ccache/Directory.Build.targets#L13
I use depends to check node depends, then a zlib.dll point to vcpkg installed package zlib, then I got it.

How to reproduce this problem

1. install vcpkg

git clone https://github.com/microsoft/vcpkg
cd vcpkg
bootstrap-vcpkg.bat

3. install zlib

: I use vcpkg install boost opentelem-cpp[oltp-http,oltp-grpc]
vcpkg install zlib

5. enable vcpkg integrate

vcpkg integrate install

7. build nodejs with vcbuild.bat

git clone https://github.com/nodejs/node.git
cd node
: I use vcbuild.bat x64 dll debug
vcbuild.bat x64 dll

9. you should failed with symbol redefine
10. disable vcpkg integrate

cd vcpkg_repo_dir
vcpkg integrate remove

12. rebuild nodejs, you should success

cd node_repo_dir
: I use vcbuild.bat x64 dll debug
vcbuild.bat x64 dll

14. if not, try to remove out dir, and rebuild

cd node_repo_dir
rmdir out /q /s /f
: I use vcbuild.bat x64 dll debug
vcbuild.bat x64 dll

15. then at least vcpkg has some relation with nodejs build failed

Btw

that should be a misconfig of vcpkg .props/.target hook? can you cc to upstream?

[StefanStojanovic]

I've created a fresh VM and tried out the scenario you suggested. All played out as you said it would, so although I've never experienced this before I can confirm your tip for fixing it works.

The remove command you have in the BUILDING.md isn't correct (the one in your comment is), so please change that and I'll approve the PR.

[congzhangzh]

I've created a fresh VM and tried out the scenario you suggested. All played out as you said it would, so although I've never experienced this before I can confirm your tip for fixing it works.

The remove command you have in the BUILDING.md isn't correct (the one in your comment is), so please change that and I'll approve the PR.

@StefanStojanovic Hi Stefan, that's cool, and I change that follow you advice, please review again :)

[StefanStojanovic]

The change LGTM.

[H4ad]

Giving the approval on behalf of @StefanStojanovic, thanks for the great review, and @congzhangzh thanks for the PR.

[nodejs-github-bot]

Landed in dd711d2