Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation - need to use double quotes not apostrophes to surr… #9758

Merged
merged 1 commit into from
Dec 22, 2021
Merged

Fix documentation - need to use double quotes not apostrophes to surr… #9758

merged 1 commit into from
Dec 22, 2021

Conversation

benda
Copy link
Contributor

@benda benda commented Dec 22, 2021

Motivation / Problem

Windows compilation documentation has a typo.

Description

need to use double quotes

Limitations

Checklist for review

@LordAro
Copy link
Member

LordAro commented Dec 22, 2021

While I agree it should be consistent, single quotes should work just fine - what errors are you getting with the existing command?

@benda
Copy link
Contributor Author

benda commented Dec 22, 2021

It does not work as is (at least for me on Windows 10), it gives the error below:

C:\Dev\OpenTTD\build>cmake.exe .. -G'Visual Studio 16 2019' -DCMAKE_TOOLCHAIN_FILE="C:\Dev\vcpkg\scripts\buildsystems\vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows-static"
CMake Error: Could not create named generator 'Visual

Generators
Visual Studio 17 2022 = Generates Visual Studio 2022 project files.
Use -A option to specify architecture.

  • Visual Studio 16 2019 = Generates Visual Studio 2019 project files.
    Use -A option to specify architecture.
    Visual Studio 15 2017 [arch] = Generates Visual Studio 2017 project files.
    Optional [arch] can be "Win64" or "ARM".
    Visual Studio 14 2015 [arch] = Generates Visual Studio 2015 project files.
    Optional [arch] can be "Win64" or "ARM".
    Visual Studio 12 2013 [arch] = Generates Visual Studio 2013 project files.
    Optional [arch] can be "Win64" or "ARM".
    Visual Studio 11 2012 [arch] = Generates Visual Studio 2012 project files.
    Optional [arch] can be "Win64" or "ARM".
    Visual Studio 10 2010 [arch] = Deprecated. Generates Visual Studio 2010
    project files. Optional [arch] can be
    "Win64" or "IA64".
    Visual Studio 9 2008 [arch] = Generates Visual Studio 2008 project files.
    Optional [arch] can be "Win64" or "IA64".
    Borland Makefiles = Generates Borland makefiles.
    NMake Makefiles = Generates NMake makefiles.
    NMake Makefiles JOM = Generates JOM makefiles.
    MSYS Makefiles = Generates MSYS makefiles.
    MinGW Makefiles = Generates a make file for use with
    mingw32-make.
    Green Hills MULTI = Generates Green Hills MULTI files
    (experimental, work-in-progress).
    Unix Makefiles = Generates standard UNIX makefiles.
    Ninja = Generates build.ninja files.
    Ninja Multi-Config = Generates build-.ninja files.
    Watcom WMake = Generates Watcom WMake makefiles.
    CodeBlocks - MinGW Makefiles = Generates CodeBlocks project files.
    CodeBlocks - NMake Makefiles = Generates CodeBlocks project files.
    CodeBlocks - NMake Makefiles JOM
    = Generates CodeBlocks project files.
    CodeBlocks - Ninja = Generates CodeBlocks project files.
    CodeBlocks - Unix Makefiles = Generates CodeBlocks project files.
    CodeLite - MinGW Makefiles = Generates CodeLite project files.
    CodeLite - NMake Makefiles = Generates CodeLite project files.
    CodeLite - Ninja = Generates CodeLite project files.
    CodeLite - Unix Makefiles = Generates CodeLite project files.
    Eclipse CDT4 - NMake Makefiles
    = Generates Eclipse CDT 4.0 project files.
    Eclipse CDT4 - MinGW Makefiles
    = Generates Eclipse CDT 4.0 project files.
    Eclipse CDT4 - Ninja = Generates Eclipse CDT 4.0 project files.
    Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files.
    Kate - MinGW Makefiles = Generates Kate project files.
    Kate - NMake Makefiles = Generates Kate project files.
    Kate - Ninja = Generates Kate project files.
    Kate - Unix Makefiles = Generates Kate project files.
    Sublime Text 2 - MinGW Makefiles
    = Generates Sublime Text 2 project files.
    Sublime Text 2 - NMake Makefiles
    = Generates Sublime Text 2 project files.
    Sublime Text 2 - Ninja = Generates Sublime Text 2 project files.
    Sublime Text 2 - Unix Makefiles
    = Generates Sublime Text 2 project files.

C:\Dev\OpenTTD\build>

glx22
glx22 approved these changes Dec 22, 2021
View reviewed changes
Copy link
Contributor

@glx22 glx22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Single quote indeed fails in cmd (powershell happily accepts both)

@benda
Copy link
Contributor Author

benda commented Dec 22, 2021

Thanks, is there anything else I need to do here to get this merged?

@James103
Copy link
Contributor

Thanks, is there anything else I need to do here to get this merged?

The commit message needs to be changed. If you can, will you please shorten the commit message and make sure that it starts with either Fix: or Doc: ?

@glx22
Copy link
Contributor

glx22 commented Dec 22, 2021

@James103 we can do that when merging :)

@glx22 glx22 merged commit 30d0f06 into OpenTTD:master Dec 22, 2021
@TrueBrain TrueBrain added the backport requested This PR should be backport to current release (RC / stable) label Jan 1, 2022
TrueBrain pushed a commit to TrueBrain/OpenTTD that referenced this pull request Jan 3, 2022
@benda @TrueBrain
Doc: use only double quotes for cmake command line example in COMPILI…
ab15dc9 
…NG.md (OpenTTD#9758)

While powershell happily accepts single quotes, it's not the case for cmd.
@TrueBrain TrueBrain mentioned this pull request Jan 3, 2022
Merged
TrueBrain pushed a commit that referenced this pull request Jan 5, 2022
@benda @TrueBrain
Doc: use only double quotes for cmake command line example in COMPILI…
2df71a1 
…NG.md (#9758)

While powershell happily accepts single quotes, it's not the case for cmd.
@TrueBrain TrueBrain added backported This PR is backported to a current release (RC / stable) and removed backport requested This PR should be backport to current release (RC / stable) labels Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glx22 glx22 glx22 approved these changes

Assignees
No one assigned
Labels
backported This PR is backported to a current release (RC / stable)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@benda @LordAro @James103 @glx22 @TrueBrain