Skip to content

Make building examples optional #44

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jeongseok-meta
Copy link
Contributor

This PR proposes an opt-out approach for building examples, allowing the package to exclude vsgXchange as a required dependency when examples are not necessary (e.g., during packaging by package managers).

@robertosfield
Copy link
Collaborator

This will be a theme we'll see with other VSG add-on libraries. Perhaps it may be worth looking at standardizing the convention we use for building examples.

Is there any convention used in other projects that are worth looking at as reference?

It might be that we can make examples default to off. Or have a general env var/CMAKE var that we can use when building the various libraries and pure libraries.

@jeongseok-meta
Copy link
Contributor Author

I agree that standardizing the convention for building examples across VSG add-on libraries is a good idea.

I've researched existing conventions and found that using environment variables or CMake variables, such as BUILD_EXAMPLES, is common practice. However, it's worth noting that there isn't a specific standard from CMake for building examples. Many projects use the *_BUILD_EXAMPLES variable, but the default value is typically up to the author. We could use VSG_BUILD_EXAMPLES or VSGQT_BUILD_EXAMPLES, where the latter seems the current convention of the vsg add-on libraries for CMake options.

In this case, I'm considering making examples opt-out by default, allowing novice users to easily try out the examples without changing any options. This approach seems user-friendly and convenient.

Ultimately, the decision on how to handle building examples is up to you, and I'll await your feedback before proceeding with any changes!

@jeongseok-meta
Copy link
Contributor Author

In any case, please feel free to directly modify this PR as needed :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants