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.

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

Clarify liboqs_DIR naming convention #292

Merged
merged 2 commits into from
Oct 23, 2023

Conversation

ajbozarth
Copy link
Member

As per discussion in #277 we want to clarify why the env var liboqs_DIR does not follow standard naming convention by using lowercase.

Fixes #277

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.
@ajbozarth ajbozarth requested a review from baentsch as a code owner October 23, 2023 18:17
@ajbozarth
Copy link
Member Author

@baentsch @thb-sb does this small addition to the docs look good to you two to clarify our decisions from #273 #277 #275 ?

@ghost
Copy link

ghost commented Oct 23, 2023

I'm wondering if mentioning the fact that we're using find_package could be helpful to users. Since the CMake target is named liboqs, they would know that they have to define liboqs_DIR (see the documentation of find_package).

@ajbozarth
Copy link
Member Author

That's a good idea, what if I used this sentence instead:

This uses the find_package command in cmake which checks for local builds of a package at <PackageName>_DIR

@ghost
Copy link

ghost commented Oct 23, 2023

Sounds good to me!

Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM. In future PRs, please tag documentation-only changes with "[skip ci]" to avoid running pointless testing. The environment says Thanks.

@baentsch baentsch merged commit 8a96fed into open-quantum-safe:main Oct 23, 2023
1 check passed
@ajbozarth
Copy link
Member Author

please tag documentation-only changes

good to know, many projects don't have that feature

@ajbozarth ajbozarth deleted the disc277 branch October 23, 2023 19:58
@baentsch
Copy link
Member

please tag documentation-only changes

good to know, many projects don't have that feature

Yup, many IT projects don't care about their environmental impact. There's a reason data centers need about 200 TWh per year, i.e., as much as Israel, Switzerland and Finland together generate... OK, badly programmed AI probably is the biggest culprit, but just pointing to others is a cop out.

feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 13, 2024
* Clarify liboqs_DIR naming convention

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.

* added link to cmake command doc

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 16, 2024
* Clarify liboqs_DIR naming convention

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.

* added link to cmake command doc

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
* Clarify liboqs_DIR naming convention

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.

* added link to cmake command doc

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
* Clarify liboqs_DIR naming convention

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.

* added link to cmake command doc

Signed-off-by: Felipe Ventura <[email protected]>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
* Clarify liboqs_DIR naming convention

As per discussion in open-quantum-safe#277 we want to clarify why the env var
`liboqs_DIR` does not follow standard naming convention by
using lowercase.

* added link to cmake command doc

Signed-off-by: Felipe Ventura <[email protected]>
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