Skip to content

Update build-from-source tutorial. Correct options, dependencies, and targets#271

Merged
eXpl0it3r merged 1 commit intoSFML:masterfrom
JonnyPtn:build_source
Jan 12, 2026
Merged

Update build-from-source tutorial. Correct options, dependencies, and targets#271
eXpl0it3r merged 1 commit intoSFML:masterfrom
JonnyPtn:build_source

Conversation

@JonnyPtn
Copy link
Copy Markdown
Contributor

@JonnyPtn JonnyPtn commented Jan 8, 2026

Info in these sections was out of date.

Made a few other minor corrections and tidy up

@eXpl0it3r eXpl0it3r added the bug label Jan 8, 2026
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md
Copy link
Copy Markdown
Member

@eXpl0it3r eXpl0it3r left a comment

Choose a reason for hiding this comment

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

Thanks a lot for updating this! I've added a bunch of comments.

Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
Comment thread pages/tutorials/3.0/getting-started/build-from-source.md
@eXpl0it3r
Copy link
Copy Markdown
Member

eXpl0it3r commented Jan 8, 2026

We should mention the following three options:

  • SFML_USE_MESA3D
  • SFML_WARNINGS_AS_ERRORS
  • SFML_FATAL_OPENGL_ERRORS <- Hmmm should this be part of the CONFIGURE_EXTRAS? 🤔

Wonder if the "developer" options should also be listed:

  • SFML_CONFIGURE_EXTRAS
  • SFML_ENABLE_COVERAGE
  • SFML_ENABLE_PCH
  • SFML_ENABLE_SANITIZERS
  • SFML_ENABEL_STDLIB_ASSERTIONS

@JonnyPtn
Copy link
Copy Markdown
Contributor Author

JonnyPtn commented Jan 8, 2026

SFML_USE_MESA3D I would not document, as I understand it's simply an option enabled for CI builds on windows where the system opengl implementation may not work, and not really a feature end users should be using

SFML_WARNINGS_AS_ERRORS I think is pretty much obselete now cmake has an official option for it. We could still document the cmake option with a tl;dr of the official documentation if desired, as we do for some others here

The others I'm not entirely sure about - they are generally more advanced/developer options that people typically won't care about, and they are already somewhat documented by the cmake code itself with descriptions that also show in the cmake gui. There are also plenty more that aren't documented here that you haven't mentioned so it could be a bit of a rabbit hole.

Perhaps worth clarifying what the intention of this tutorial is, as "building from source" covers a very wide range of use-cases. Could just be and end user wanting to quickly build SFML so they can use it (which I get the impression was the original intention), could be a contributor wanting to debug and test some new feature, Could be a package manager maintainer wanting to produce a selection of builds, all of which have very different requirements

Copy link
Copy Markdown
Member

@eXpl0it3r eXpl0it3r left a comment

Choose a reason for hiding this comment

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

I think it's fine to not mention the other options for now and maybe expand on other topics later on.

Comment thread pages/tutorials/3.0/getting-started/build-from-source.md Outdated
@eXpl0it3r eXpl0it3r merged commit 48dd6dc into SFML:master Jan 12, 2026
@eXpl0it3r
Copy link
Copy Markdown
Member

Thank you for updating this! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants