Document x-test-features and format-feature-baseline#455
Document x-test-features and format-feature-baseline#455vicroms merged 11 commits intoMicrosoftDocs:mainfrom
x-test-features and format-feature-baseline#455Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
vcpkg/commands/test-features.md
Outdated
| * **no-separate-feature-test** - The listed features are not tested in the "seperate" feature test. | ||
| * **options** - The listed features are mutually exclusive and can not be selected together. The | ||
| first feature in the list is added to every test combination. Use the `core` feature as first one | ||
| to add no feature to every test combination. |
There was a problem hiding this comment.
It's not clear to me what this means.
There was a problem hiding this comment.
I'll be honest, it isn't super clear to me either. @autoantwort can you clarify?
There was a problem hiding this comment.
If we have for example a library A that can be build with openssl or boringssl the following would be tested by default:
a[core]"core"a[core, openssl]"test-features"a[core, boringssl]"test-features"a[core, some-feature]"test-features"a[core, openssl, boringssl, some-feature]"test-features-combined"
Now it is often the case that you can not select openssl and boringssl at the same time. If the lib works when no ssl backend is selected you would choose a[core, openssl, boringssl] = options which would result in
a[core]a[core, openssl]a[core, boringssl]a[core, some-feature]
But in case you must at least select one ssl backend you would write a[openssl, boringssl] = options which would result in
a[core, openssl]a[core, boringssl]a[core, openssl, some-feature]
In the example block there is the following
## Examples:
## qt3d[extras] = options # extras will be always added to the test combination (it is currently a requirement)
## curl[core,openssl,wolfssl] = options # openssl and wolfssl are exclusive ssl backends but none must be selected
## libgit2[pcre,pcre2] = options # you have to select pcre xor pcre2
Co-authored-by: Thomas1664 <46387399+Thomas1664@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
vcpkg/commands/test-features.md
Outdated
|
|
||
| ## Description | ||
|
|
||
| Tests all features of a package by installing them in manifest mode. This command is useful for testing that all features of a package are working correctly. |
There was a problem hiding this comment.
| Tests all features of a package by installing them in manifest mode. This command is useful for testing that all features of a package are working correctly. | |
| Installs all features of a package using manifest mode. This command is designed for testing that all features of a package work correctly. |
There was a problem hiding this comment.
I think "tests" is correct rather than "installed" as the intended outcome isn't an installation. Moreover, the following block "the following tests are performed" doesn't really make sense in an "installs" context.
I applied everything else.
| ... | ||
| ``` | ||
|
|
||
| ## Options |
There was a problem hiding this comment.
Also needs --for-merge-with
This comment was marked as outdated.
This comment was marked as outdated.
|
Also needs |
|
Learn Build status updates of commit cc2c40d:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| vcpkg/commands/test-features.md | View | Details | |
| vcpkg/commands/format-feature-baseline.md | ✅Succeeded | View | |
| vcpkg/TOC.yml | ✅Succeeded | View |
vcpkg/commands/test-features.md
- Line 25, Column 50: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#ci-feature-baseline' in 'commands/test-features.md', did you mean '#--ci-feature-baseline'?
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
No: there is no page for the |
|
Learn Build status updates of commit b2c10a4: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
Resurrects #131
For microsoft/vcpkg-tool#802