Update build instructions for Visual Studio 2019 #4394

drlongle · 2023-01-20T18:12:39Z

High Level Overview of Change

Update the build instructions for Visual Studio 2019.

Also fix #3037.

Context of Change

It is helpful to provide build instructions for Visual Studio to make it easier for people to build rippled on Windows. Dependencies are installed using Conan. If you have issues building, it may be helpful to uninstall Visual Studio and use Chocolatey to re-install it.

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Refactor (non-breaking change that only restructures code)
Tests (You added tests for code that already exists, or your new feature included in this PR)
Documentation Updates
Release

docs: Update Windows build instructions

cfg/rippled-example.cfg

thejohnfreeman · 2023-02-13T17:58:38Z

BUILD.md

 > **Warning**
-> The commands in this document are not meant to be blindly copied and pasted.
+> The commands in this document are guidelines which cannot always be successfully copy and pasted.


I would call them examples, not guidelines.

copy -> copied
or
copy and pasted -> copy-and-pasted

Please break lines at 80 characters. Yes, even Markdown.

thejohnfreeman · 2023-02-13T18:00:51Z

BUILD.md

+### All Platforms
+
+To build this package, you will need [Python][] (>= 3.7),
+[Conan][] (>= 1.52), and [CMake][] (>= 3.16).


I do not believe Conan 1.52 is sufficient any more. We should recommend the latest anyway given all the recent changes (1.58).

thejohnfreeman · 2023-02-13T18:01:17Z

BUILD.md

+To build this package, you will need [Python][] (>= 3.7),
+[Conan][] (>= 1.52), and [CMake][] (>= 3.16).
+If you are unfamiliar with Conan,
+there is a crash course at the end of this document.


Beginning of the document. Are these changes based off an old version of this document?

Fixed.

I am not sure what version @justinr1234 based his changes on.

thejohnfreeman · 2023-02-13T18:02:56Z

BUILD.md


 You'll need to compile in the C++20 dialect:

 ```
-conan profile update settings.compiler.cppstd=20 default
+conan profile update settings.cppstd=20 default


This is the wrong command, from an old version of Conan. It was already updated in this document.

Thanks. Fixed.

thejohnfreeman · 2023-02-13T18:04:03Z

BUILD.md

+If you've never used Conan before, use autodetect to setup a default profile:
+
+```
+conan profile new default --detect
+```


This command is already in the crash course. This section assumes the person has installed and configured Python, Conan, and CMake.

It does not seem too bad to repeat that command. However, I'll be happy to remove it if you prefer. Please let me know.

Personally, I think it is good to repeat the command. Obviously, there is a balance (we wouldn't want to repeat it 5 times). But this looks ok to me.

thejohnfreeman · 2023-02-13T18:05:31Z

BUILD.md

-Let's start with a couple of examples of common workflows.
-The first is for a single-configuration generator (e.g. Unix Makefiles) on
-Linux or MacOS:
-
-```
-conan export external/rocksdb
-mkdir .build
-cd .build
-conan install .. --output-folder . --build missing --settings build_type=Release
-cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
-cmake --build .
-./rippled --unittest
-```
-
-The second is for a multi-configuration generator (e.g. Visual Studio) on
-Windows:
-
-```
-conan export external/rocksdb
-mkdir .build
-cd .build
-conan install .. --output-folder . --build missing --settings build_type=Release --settings compiler.runtime=MT
-conan install .. --output-folder . --build missing --settings build_type=Debug --settings compiler.runtime=MTd
-cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake ..
-cmake --build . --config Release
-cmake --build . --config Debug
-./Release/rippled --unittest
-./Debug/rippled --unittest
-```


Why are these instructions removed? To what steps do the numbered explanations correspond?

@justinr1234 probably removed them by mistake. I put them back.

It was removed when there wasn’t a separate readme.

As far as these instructions, it shouldn’t have Debug and Release together like that as both myself and @drlongle ran into issues with mixing debug and release builds back to back.

thejohnfreeman · 2023-02-13T18:08:34Z

Builds/VisualStudio2019/README.md

+While there are several options for building `rippled` on Windows, we recommend using
+[Chocolatey, Conan, CMake and Visual Studio](README.md#build-using-chocolatey-conan-cmake-and-visual-studio-recommended).
+If using this option, you can skip the section [Install Software](README.md#install-software)
+because Conan automatically installs all dependencies for `rippled`.
+
+


Editing this document reflects a totally different philosophy on how to present build instructions in this repo. I've got a waiting PR to remove this file.

Is it better to revert all changes for Builds/VisualStudio2019/README.md and add Windows-specific instructions to BUILD.md?

dangell7 · 2023-02-14T21:07:20Z

bump for .gitignore :)

intelliot · 2023-02-14T22:44:01Z

FWIW, I would have been fine with merging #4397 as a "quick fix" while this other PR is undergoing review and revisions.

intelliot · 2023-02-15T19:06:49Z

we can revert the changes to the Windows part
other changes can be made in BUILD.md

…#4394

justinr1234 · 2023-04-06T23:37:02Z

@drlongle can you update conflicts and I’ll do a review?

thejohnfreeman · 2023-04-07T04:56:07Z

I'd like to see most of this moved to docs/environment.md, like we agreed in #4433 (reply in thread).

drlongle · 2023-04-17T10:28:23Z

I'd like to see most of this moved to docs/environment.md, like we agreed in #4433 (reply in thread).

Agreed. Unless there is any objection, let's delete this PR and open a new one.

intelliot · 2023-04-18T04:22:58Z

@drlongle feel free to close this PR and open a new one, at your convenience.

justinr1234 and others added 3 commits January 19, 2023 17:15

docs: Update Windows build instructions

dcfe6a1

Update build instructions for Visual Studio 2019

b21bbe2

Merge pull request #1 from justinr1234/windows-docs

e3185c7

docs: Update Windows build instructions

legleux reviewed Jan 23, 2023

View reviewed changes

cfg/rippled-example.cfg Show resolved Hide resolved

intelliot approved these changes Jan 24, 2023

View reviewed changes

intelliot requested a review from legleux January 24, 2023 17:28

intelliot assigned legleux Jan 24, 2023

intelliot mentioned this pull request Feb 6, 2023

add .build to gitignore #4397

Closed

7 tasks

intelliot added Build System Documentation README changes, code comments, etc. High Priority Will Need Documentation labels Feb 6, 2023

intelliot requested review from thejohnfreeman and ximinez February 7, 2023 07:03

intelliot removed High Priority labels Feb 7, 2023

intelliot assigned thejohnfreeman Feb 7, 2023

thejohnfreeman requested changes Feb 13, 2023

View reviewed changes

intelliot assigned drlongle Feb 14, 2023

Address review

edeff7e

intelliot requested review from justinr1234 and thejohnfreeman February 15, 2023 17:56

oeggert added a commit to oeggert/rippled that referenced this pull request Feb 18, 2023

Second pass of updates. Add ToC and incorporate changes from PR XRPLF…

257f6b0

…#4394

thejohnfreeman mentioned this pull request Mar 3, 2023

Refactor build instructions #4381

Merged

intelliot removed the request for review from ximinez April 6, 2023 23:33

intelliot unassigned legleux and thejohnfreeman Apr 12, 2023

drlongle closed this Apr 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update build instructions for Visual Studio 2019 #4394

Update build instructions for Visual Studio 2019 #4394

drlongle commented Jan 20, 2023 •

edited by intelliot

Loading

thejohnfreeman Feb 13, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

intelliot Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023 •

edited

Loading

justinr1234 Feb 15, 2023

thejohnfreeman Feb 13, 2023

drlongle Feb 15, 2023

dangell7 commented Feb 14, 2023

intelliot commented Feb 14, 2023

intelliot commented Feb 15, 2023

justinr1234 commented Apr 6, 2023

thejohnfreeman commented Apr 7, 2023

drlongle commented Apr 17, 2023

intelliot commented Apr 18, 2023

Update build instructions for Visual Studio 2019 #4394

Update build instructions for Visual Studio 2019 #4394

Conversation

drlongle commented Jan 20, 2023 • edited by intelliot Loading

High Level Overview of Change

Context of Change

Type of Change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drlongle Feb 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dangell7 commented Feb 14, 2023

intelliot commented Feb 14, 2023

intelliot commented Feb 15, 2023

justinr1234 commented Apr 6, 2023

thejohnfreeman commented Apr 7, 2023

drlongle commented Apr 17, 2023

intelliot commented Apr 18, 2023

drlongle commented Jan 20, 2023 •

edited by intelliot

Loading

drlongle Feb 15, 2023 •

edited

Loading