Clarify network interface setting #66013
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Today we document the use of `_[networkInterface]_` to specify the addresses of a network interface but do not spell out which parts of this syntax should be taken literally and which are part of the placeholder for the interface name. If you get it wrong then the exception message is confusing too since it uses the results of `NetworkInterface#toString()` which contains much more than just the name of the interface. This commit clarifies the docs and the exception message. Closes elastic#65978.
DaveCTurner
added
>enhancement
>docs
elasticmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-distributed (Team:Distributed) |
DaveCTurner
added a commit
that referenced
this pull request
Dec 9, 2020
Today we document the use of `_[networkInterface]_` to specify the addresses of a network interface but do not spell out which parts of this syntax should be taken literally and which are part of the placeholder for the interface name. If you get it wrong then the exception message is confusing too since it uses the results of `NetworkInterface#toString()` which contains much more than just the name of the interface. This commit clarifies the docs and the exception message. Closes #65978.
DaveCTurner
added a commit
that referenced
this pull request
Dec 9, 2020
Today we document the use of `_[networkInterface]_` to specify the addresses of a network interface but do not spell out which parts of this syntax should be taken literally and which are part of the placeholder for the interface name. This commit clarifies the docs. NB this is a backport of just the docs changes from #66013. Closes #65978.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today we document the use of
_[networkInterface]_to specify theaddresses of a network interface but do not spell out which parts of
this syntax should be taken literally and which are part of the
placeholder for the interface name. If you get it wrong then the
exception message is confusing too since it uses the results of
NetworkInterface#toString()which contains much more than just thename of the interface.
This commit clarifies the docs and the exception message.
Closes #65978.