You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2021/07/16 10:57:55 UTC
[GitHub] [flink] Airblader opened a new pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Airblader opened a new pull request #16515:
URL: https://github.com/apache/flink/pull/16515
## What is the purpose of the change
This introduces a new interface which can be implemented for enums which are used in (enum-based) `ConfigOption`s. It allows providing documentation about the individual values. This is then used in `ConfigOptionsDocGenerator`: the list of available values is moved from "Type" to "Description", and if the interface is implemented, the provided documentation is added to each listed value.
One note: `DescribedEnum#getDescription` cannot return an actual `Description` because those cannot be nested into a list, only inline elements can.
This PR also goes through the enum options currently covered by the docs generator and applies this change there. In #16482 this will be used to convert some string-based connector options into enum-based ones as well.
## Brief change log
* `DescribedEnum` interface for enums used in options
* `ConfigOptionsDocGenerator` to make use of this new interface
* Cleaned up some options to use this new feature
## Verifying this change
This change added tests and can be verified as follows:
* `ConfigOptionsDocGeneratorTest`
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: yes
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
- The S3 file system connector: no
## Documentation
- Does this pull request introduce a new feature? no
- If yes, how is the feature documented? JavaDocs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633)
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881370494
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit 9f0bfb4484ae3d05fd7c2550294456817b3e01cb (Thu Sep 23 18:07:59 UTC 2021)
**Warnings:**
* No documentation files were touched! Remember to keep the Flink docs up to date!
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 84d38b9377eb90a2340baeef61d58d4daebc2d00 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633)
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
}, {
"hash" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773",
"triggerID" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
* ec20337fab8772ddc7d3ab47c0e3faa052ee328d Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764)
* 9f0bfb4484ae3d05fd7c2550294456817b3e01cb Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 2b535d1b7dd554a8777d1bcd5f6938986cac0bd9 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579)
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567)
* 2b535d1b7dd554a8777d1bcd5f6938986cac0bd9 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 2b535d1b7dd554a8777d1bcd5f6938986cac0bd9 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
twalthr commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r672107230
##########
File path: flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/EmbeddedRocksDBStateBackend.java
##########
@@ -91,12 +91,6 @@
public class EmbeddedRocksDBStateBackend extends AbstractManagedMemoryStateBackend
implements ConfigurableStateBackend {
- /** The options to chose for the type of priority queue state. */
- public enum PriorityQueueStateType {
Review comment:
yes, let's leave the enum there for now. The class is marked as `PublicEvolving` but this is actually not correct. The RocksDB State Backend has evolved to `Public` nowadays, so we need to be careful.
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java
##########
@@ -53,6 +55,11 @@ public static TextElement text(String text) {
return new TextElement(text, Collections.emptyList());
}
+ /** Wraps a list of {@link InlineElement}s into a single {@link TextElement}. */
+ public static InlineElement wrap(List<InlineElement> elements) {
Review comment:
wouldn't be a vararg more handy?
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java
##########
@@ -53,6 +55,11 @@ public static TextElement text(String text) {
return new TextElement(text, Collections.emptyList());
}
+ /** Wraps a list of {@link InlineElement}s into a single {@link TextElement}. */
+ public static InlineElement wrap(List<InlineElement> elements) {
Review comment:
btw we should add a test for it, it is not used anywhere in this PR right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r671670948
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/DescribedEnum.java
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.configuration;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.InlineElement;
+import org.apache.flink.configuration.description.TextElement;
+
+import java.util.List;
+
+/**
+ * Describe enum constants used in {@link ConfigOption}s.
+ *
+ * <p>For enums used as config options, this interface can be implemented to provide a {@link
+ * Description} for each enum constant. This will be used when generating documentation for config
+ * options to include a list of available values alongside their respective descriptions.
+ *
+ * <p>More precisely, only a list of {@link InlineElement}s can be returned as block elements cannot
+ * be nested into a list.
+ */
+@PublicEvolving
+public interface DescribedEnum {
+
+ /**
+ * Returns the description for the enum constant.
+ *
+ * <p>Typically, this will return a simple, single {@link TextElement}.
+ */
+ List<InlineElement> getDescription();
Review comment:
However, one could also wrap multiple inline elements into a single one, like I did in `ConfigOptionsDocGenerator#wrap`. Maybe it makes sense to simplify the API and just offer a utility method to do that instead.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "CANCELED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
}, {
"hash" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773",
"triggerID" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* ec20337fab8772ddc7d3ab47c0e3faa052ee328d Azure: [CANCELED](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764)
* 9f0bfb4484ae3d05fd7c2550294456817b3e01cb Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881577888
@twalthr Thanks for the review! I split it into two commits and also left `PriorityQueueStateType` where it was to prevent breakage here. I don't think we need to undo the change to use `DescribedEnum` for it, though, right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
}, {
"hash" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
* ec20337fab8772ddc7d3ab47c0e3faa052ee328d Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764)
* 9f0bfb4484ae3d05fd7c2550294456817b3e01cb UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 84d38b9377eb90a2340baeef61d58d4daebc2d00 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622)
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633)
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
}, {
"hash" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"status" : "SUCCESS",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773",
"triggerID" : "9f0bfb4484ae3d05fd7c2550294456817b3e01cb",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* 9f0bfb4484ae3d05fd7c2550294456817b3e01cb Azure: [SUCCESS](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20773)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
twalthr commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r672107230
##########
File path: flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/EmbeddedRocksDBStateBackend.java
##########
@@ -91,12 +91,6 @@
public class EmbeddedRocksDBStateBackend extends AbstractManagedMemoryStateBackend
implements ConfigurableStateBackend {
- /** The options to chose for the type of priority queue state. */
- public enum PriorityQueueStateType {
Review comment:
yes, let's leave the enum there for now. The class is marked as `PublicEvolving` but this is actually not correct. The RocksDB State Backend has evolved to `Public` nowadays, so we need to be careful.
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java
##########
@@ -53,6 +55,11 @@ public static TextElement text(String text) {
return new TextElement(text, Collections.emptyList());
}
+ /** Wraps a list of {@link InlineElement}s into a single {@link TextElement}. */
+ public static InlineElement wrap(List<InlineElement> elements) {
Review comment:
wouldn't be a vararg more handy?
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java
##########
@@ -53,6 +55,11 @@ public static TextElement text(String text) {
return new TextElement(text, Collections.emptyList());
}
+ /** Wraps a list of {@link InlineElement}s into a single {@link TextElement}. */
+ public static InlineElement wrap(List<InlineElement> elements) {
Review comment:
btw we should add a test for it, it is not used anywhere in this PR right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r673775404
##########
File path: flink-docs/src/test/java/org/apache/flink/docs/configuration/ConfigOptionsDocsCompletenessITCase.java
##########
@@ -257,7 +254,7 @@ private static void compareDocumentedAndExistingOptions(
// Use split to exclude document key tag.
String key = tableRow.child(0).text().split(" ")[0];
String defaultValue = tableRow.child(1).text();
- String typeValue = tableRow.child(2).text();
+ String typeValue = tableRow.child(2).html();
Review comment:
Here we're parsing the type from the current docs, and "on the other side" we're generating it from the `ConfigOption`. Since there we do so by calling `typeToHtml`, we need to also preserve the HTML here for the comparison to work.
This happened to work previously because `#text()` preserves HTML in `<p>A</p>B`, but not in `<p>A</p>` (for whatever reason).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 84d38b9377eb90a2340baeef61d58d4daebc2d00 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622)
* 7991fd26d867a56eac6f1dc5f8ff525e69a39b3b Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
* ec20337fab8772ddc7d3ab47c0e3faa052ee328d Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20764)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r673675192
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/description/TextElement.java
##########
@@ -53,6 +55,11 @@ public static TextElement text(String text) {
return new TextElement(text, Collections.emptyList());
}
+ /** Wraps a list of {@link InlineElement}s into a single {@link TextElement}. */
+ public static InlineElement wrap(List<InlineElement> elements) {
Review comment:
It's used in `ConfigOptionsDocGenerator`. There the list signature is also definitely more convenient, but I can change it to varargs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 2b535d1b7dd554a8777d1bcd5f6938986cac0bd9 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579)
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "PENDING",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604)
* 84d38b9377eb90a2340baeef61d58d4daebc2d00 Azure: [PENDING](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
twalthr commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r671302096
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/DescribedEnum.java
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.configuration;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.InlineElement;
+import org.apache.flink.configuration.description.TextElement;
+
+import java.util.List;
+
+/**
+ * Describe enum constants used in {@link ConfigOption}s.
+ *
+ * <p>For enums used as config options, this interface can be implemented to provide a {@link
+ * Description} for each enum constant. This will be used when generating documentation for config
+ * options to include a list of available values alongside their respective descriptions.
+ *
+ * <p>More precisely, only a list of {@link InlineElement}s can be returned as block elements cannot
+ * be nested into a list.
+ */
+@PublicEvolving
+public interface DescribedEnum {
+
+ /**
+ * Returns the description for the enum constant.
+ *
+ * <p>Typically, this will return a simple, single {@link TextElement}.
+ */
+ List<InlineElement> getDescription();
Review comment:
Why do we use a `List` here? Is there a concrete use case?
##########
File path: flink-docs/src/main/java/org/apache/flink/docs/configuration/ConfigOptionsDocGenerator.java
##########
@@ -440,6 +450,12 @@ private static String toHtmlString(final OptionWithMetaInfo optionWithMetaInfo)
}
}
+ final String enumOptions =
Review comment:
nit: maybe `enumValuesSection` instead of "Options" here and below? there are too many things called "Options" :D
##########
File path: flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/EmbeddedRocksDBStateBackend.java
##########
@@ -91,12 +91,6 @@
public class EmbeddedRocksDBStateBackend extends AbstractManagedMemoryStateBackend
implements ConfigurableStateBackend {
- /** The options to chose for the type of priority queue state. */
- public enum PriorityQueueStateType {
Review comment:
not sure about this change, it could break existing pipelines because it is exposed via `setPriorityQueueStateType`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* 67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604)
* 84d38b9377eb90a2340baeef61d58d4daebc2d00 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r671387127
##########
File path: flink-state-backends/flink-statebackend-rocksdb/src/main/java/org/apache/flink/contrib/streaming/state/EmbeddedRocksDBStateBackend.java
##########
@@ -91,12 +91,6 @@
public class EmbeddedRocksDBStateBackend extends AbstractManagedMemoryStateBackend
implements ConfigurableStateBackend {
- /** The options to chose for the type of priority queue state. */
- public enum PriorityQueueStateType {
Review comment:
You mean breaking because the location of the enum changes? I can also leave the enum here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot commented on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot commented on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881370494
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed (Fri Jul 16 11:13:19 UTC 2021)
**Warnings:**
* No documentation files were touched! Remember to keep the Flink docs up to date!
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r671671538
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/DescribedEnum.java
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.configuration;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.InlineElement;
+import org.apache.flink.configuration.description.TextElement;
+
+import java.util.List;
+
+/**
+ * Describe enum constants used in {@link ConfigOption}s.
+ *
+ * <p>For enums used as config options, this interface can be implemented to provide a {@link
+ * Description} for each enum constant. This will be used when generating documentation for config
+ * options to include a list of available values alongside their respective descriptions.
+ *
+ * <p>More precisely, only a list of {@link InlineElement}s can be returned as block elements cannot
+ * be nested into a list.
+ */
+@PublicEvolving
+public interface DescribedEnum {
+
+ /**
+ * Returns the description for the enum constant.
+ *
+ * <p>Typically, this will return a simple, single {@link TextElement}.
+ */
+ List<InlineElement> getDescription();
Review comment:
Yeah, I think that's better, since it's also the more common case. I've updated it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] twalthr closed pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
twalthr closed pull request #16515:
URL: https://github.com/apache/flink/pull/16515
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] flinkbot edited a comment on pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on pull request #16515:
URL: https://github.com/apache/flink/pull/16515#issuecomment-881388403
<!--
Meta data
{
"version" : 1,
"metaDataEntries" : [ {
"hash" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20567",
"triggerID" : "ecbc5f4c3d73b0f56b2dc684688f046ca4a723ed",
"triggerType" : "PUSH"
}, {
"hash" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20579",
"triggerID" : "2b535d1b7dd554a8777d1bcd5f6938986cac0bd9",
"triggerType" : "PUSH"
}, {
"hash" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "6c47b8eea1556968e903b9c51d9bea4d5732828b",
"triggerType" : "PUSH"
}, {
"hash" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20604",
"triggerID" : "67eed80c4ff1d8c22e5a2c8d1dcd6d8d739ee737",
"triggerType" : "PUSH"
}, {
"hash" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20622",
"triggerID" : "84d38b9377eb90a2340baeef61d58d4daebc2d00",
"triggerType" : "PUSH"
}, {
"hash" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"status" : "DELETED",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20633",
"triggerID" : "7991fd26d867a56eac6f1dc5f8ff525e69a39b3b",
"triggerType" : "PUSH"
}, {
"hash" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28",
"triggerType" : "PUSH"
}, {
"hash" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"status" : "FAILURE",
"url" : "https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639",
"triggerID" : "a65d6dbd53a85170d9217787d2749d2b51f64619",
"triggerType" : "PUSH"
}, {
"hash" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"status" : "UNKNOWN",
"url" : "TBD",
"triggerID" : "ec20337fab8772ddc7d3ab47c0e3faa052ee328d",
"triggerType" : "PUSH"
} ]
}-->
## CI report:
* 6c47b8eea1556968e903b9c51d9bea4d5732828b UNKNOWN
* a1c1dbf9196ce9a2bc5750f98be09bedc9d74e28 UNKNOWN
* a65d6dbd53a85170d9217787d2749d2b51f64619 Azure: [FAILURE](https://dev.azure.com/apache-flink/98463496-1af2-4620-8eab-a2ecc1a2e6fe/_build/results?buildId=20639)
* ec20337fab8772ddc7d3ab47c0e3faa052ee328d UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [flink] Airblader commented on a change in pull request #16515: [FLINK-23369][core][docs] Mechanism to document enums used in ConfigOptions
Posted by GitBox <gi...@apache.org>.
Airblader commented on a change in pull request #16515:
URL: https://github.com/apache/flink/pull/16515#discussion_r671347200
##########
File path: flink-core/src/main/java/org/apache/flink/configuration/DescribedEnum.java
##########
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.flink.configuration;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.InlineElement;
+import org.apache.flink.configuration.description.TextElement;
+
+import java.util.List;
+
+/**
+ * Describe enum constants used in {@link ConfigOption}s.
+ *
+ * <p>For enums used as config options, this interface can be implemented to provide a {@link
+ * Description} for each enum constant. This will be used when generating documentation for config
+ * options to include a list of available values alongside their respective descriptions.
+ *
+ * <p>More precisely, only a list of {@link InlineElement}s can be returned as block elements cannot
+ * be nested into a list.
+ */
+@PublicEvolving
+public interface DescribedEnum {
+
+ /**
+ * Returns the description for the enum constant.
+ *
+ * <p>Typically, this will return a simple, single {@link TextElement}.
+ */
+ List<InlineElement> getDescription();
Review comment:
Yeah, if you want to add links or code, you'd need to use multiple inline elements.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org