improve `--dns` documentation
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 14.6k
- Forks
- 3.4k
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/OpenVPN/openvpn/issues/473 suggests that there are many misunderstandings lurking in the general --dns documentation and also in the interaction between --dns and --dhcp-option <dns related>, quote
This is also missing in docs which implies that
dnsover-ridesdhcp-optionwhich is not really the case always.
my understanding is that it should override, as in "if there is dns configured, dhcp-option is ignored", but I might be wrong, or might be wrong for non-windows platforms.
So, opening a separate issue to improve and clarify documentation.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the existing general --dns and --dhcp-option documentation, then review the linked issue 473 for the reported misunderstanding. Verify how the options interact across platforms before updating the documentation. Done means the precedence and platform-specific behavior are stated clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100