Chromium Code Reviews| Index: docs/windows_build_instructions.md |
| diff --git a/docs/windows_build_instructions.md b/docs/windows_build_instructions.md |
| index 2793782cbb12276cf7304febd8dbedfa48e6369c..ed06056c687a0418fc1c61d8a0ae7bd67daca353 100644 |
| --- a/docs/windows_build_instructions.md |
| +++ b/docs/windows_build_instructions.md |
| @@ -19,34 +19,35 @@ You must have Windows 7 x64 or later. x86 OSs are unsupported. |
| ### Open source contributors |
| -For building with Visual Studio 2015 (default compiler as of March 10, |
| -2016): |
| - |
| -> Install Visual Studio 2015 Update 1 or later - Community Edition |
| -> should work if its license is appropriate for you. Be sure to select |
| -> Custom install and select VC++ (which selects three sub-categories |
| -> including MFC) and, under Universal Windows App Development Tools, |
| -> select Tools (1.2) and Windows 10 SDK (10.0.10586). You must have the |
| -> 10586 SDK installed or else you will hit compile errors such as |
| -> redefined macros. |
| - |
| -For building with Visual Studio 2013 (no longer default as of March 10, |
| -2016, and not recommended - requires setting GYP\_MSVS\_VERSION=2013): |
| - |
| -> Install [Visual Studio 2013 |
| -> Community](http://www.visualstudio.com/products/visual-studio-community-vs) |
| -> or [Visual Studio 2013 |
| -> Professional](http://www.visualstudio.com/products/visual-studio-professional-with-msdn-vs) |
| -> depending on which license is appropriate for you. You can deselect |
| -> the default options if you want, but you must make sure to install |
| -> "Microsoft Foundation Classes for C++". |
| -> \ |
| -> You should also install the [Windows 10 |
| -> SDK](https://dev.windows.com/en-us/downloads/windows-10-sdk) to the |
| -> default install location. You must have SDK version 10.0.10586 or |
| -> greater installed. |
| - |
| -Run `set DEPOT\_TOOLS\_WIN\_TOOLCHAIN=0`, or set that variable in your |
| +####For building with Visual Studio 2015 (default compiler as of March 10, 2016): |
|
brucedawson
2016/04/01 17:35:25
The switchover date was actually March 11, 2016. M
|
| + |
| +Install Visual Studio 2015 Update 1 or later - Community Edition |
|
brucedawson
2016/04/01 17:35:25
Why are we removing the indenting? I know it's not
dcheng
2016/04/01 19:57:13
I did look at the original sites page and noticed
|
| +should work if its license is appropriate for you. Use the Custom Install option |
| +and select: |
| + |
| +- Visual C++, which will select three sub-categories including MFC |
| +- Universal Windows Apps Development Tools > Tools (1.2) |
| +- Universal Windows Apps Development Tools > Windows 10 SDK (10.0.10586) |
| + |
| +You must have the 10586 SDK installed or else you will hit compile errors such |
| +as redefined macros. |
| + |
| +#### For building with Visual Studio 2013 (no longer default as of March 10, 2016, and not recommended - requires setting `GYP_MSVS_VERSION=2013`): |
| + |
| +Install [Visual Studio 2013 |
| +Community](http://www.visualstudio.com/products/visual-studio-community-vs) |
| +or [Visual Studio 2013 |
| +Professional](http://www.visualstudio.com/products/visual-studio-professional-with-msdn-vs) |
| +depending on which license is appropriate for you. You can deselect |
| +the default options if you want, but you must make sure to install |
| +"Microsoft Foundation Classes for C++". |
| + |
| +You should also install the [Windows 10 |
| +SDK](https://dev.windows.com/en-us/downloads/windows-10-sdk) to the |
| +default install location. You must have SDK version 10.0.10586 or |
| +greater installed. |
| + |
| +Run `set DEPOT_TOOLS_WIN_TOOLCHAIN=0`, or set that variable in your |
| global environment. |
| Visual Studio Express 2013 is **not** supported and will not be able to |
| @@ -56,17 +57,16 @@ Compilation is done through ninja, **not** Visual Studio. |
| ### Google employees |
| -Run: `download\_from\_google\_storage --config` and follow the |
| -authentication instructions.**Note that you must authenticate with your |
| +Run: `download_from_google_storage --config` and follow the |
| +authentication instructions. **Note that you must authenticate with your |
| @google.com credentials**, not @chromium.org. Enter "0" if asked for a |
| project-id. |
| Once you've done this, the toolchain will be installed automatically for |
| you in Step 3, below (near the end of the step). |
| -The toolchain will be in depot\_tools\\win\_toolchain, and windbg can be |
| -found in |
| -depot\_tools\\win\_toolchain\\vs2013\_files\\win8sdk\\Debuggers. |
| +The toolchain will be in `depot_tools\win_toolchain`, and windbg can be |
| +found in `depot_tools\win_toolchain\vs2013_files\win8sdk\Debuggers`. |
| If you want the IDE for debugging and editing, you will need to install |
| it separately, but this is optional and not needed to build Chromium. |
| @@ -75,14 +75,14 @@ it separately, but this is optional and not needed to build Chromium. |
| Follow the steps to [check out the |
| code](https://www.chromium.org/developers/how-tos/get-the-code) (largely |
| -"fetch chromium"). |
| +`fetch chromium`). |
| ## Building |
| Build the target you are interested in. |
| ```shell |
| -ninja -C out\\Debug chrome |
| +ninja -C out\Debug chrome |
| ``` |
| Alternative (Graphical user interface): Open a generated .sln |
| @@ -90,26 +90,26 @@ file such as all.sln, right-click the chrome project and select build. |
| This will invoke the real step 4 above. Do not build the whole solution |
| since that conflicts with ninja's build management and everything will |
| explode. |
| -Substitute the build directory given to -C with out\\Debug\_x64 for |
| +Substitute the build directory given to `-C` with `out\Debug_x64` for |
| [64-bit |
| builds](https://www.chromium.org/developers/design-documents/64-bit-support) |
| in GYP, or whatever build directory you have configured if using GN. |
| ### Performance tips |
| -1. Have many and fast CPU cores and enough RAM to keep them all busy. |
| +1. Have a lot of fast CPU cores and enough RAM to keep them all busy. |
| (Minimum recommended is 4-8 fast cores and 16-32 GB of RAM) |
| 2. Reduce file system overhead by excluding build directories from |
| antivirus and indexing software. |
| 3. Store the build tree on a fast disk (preferably SSD). |
| 4. If you are primarily going to be doing debug development builds, you |
| - use the component build (in |
| - [GYP](https://www.chromium.org/developers/gyp-environment-variables) |
| - do set GYP\_DEFINES=component=shared\_library, in |
| - [GN](https://www.chromium.org/developers/gn-build-configuration), |
| - set the build arg is\_component\_build = true). This will generate |
| - many DLLs and enable incremental linking, which makes linking |
| - *much*faster in Debug. |
| - |
| -Still expect build times of 30 minutes to 2 hours when everything has to |
| + should use the component build: |
| + - for [GYP](https://www.chromium.org/developers/gyp-environment-variables) |
| + set `GYP_DEFINES=component=shared_library` |
| + - for [GN](https://www.chromium.org/developers/gn-build-configuration), |
| + set the build arg `is_component_build = true`. |
| + This will generate many DLLs and enable incremental linking, which makes |
| + linking **much** faster in Debug. |
| + |
| +Still, expect build times of 30 minutes to 2 hours when everything has to |
| be recompiled. |