[PR #3071] [MERGED] hickory-dns bin & server crate comment tidying #3537

New issue

Closed

opened 2026-03-16 11:49:04 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 11:49:04 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hickory-dns/hickory-dns/pull/3071
Author: @cpu
Created: 6/19/2025
Status: ✅ Merged
Merged: 6/20/2025
Merged by: @djc

Base: main ← Head: cpu-comment-crawl_dev

📝 Commits (10+)

6622479 hickory-server: update usage opts rustdoc comment
d65b25c scripts: remove reference to non-existent native-tls dir
bf36e6f hickory-dns: remove stale native-tls comments
64d2a69 docs: remove some stale ref's to native-tls
6de4857 tests/test-data: replace gen-keys.sh comments
e7d5a84 hickory-server: fix prom. server comment typo
8da0de6 hickory-dns: remove template Cargo.toml comments
9ec5fa5 server/authority: remove stale lifetime comments
6a2d1c5 server/authority: update AnyRecords comment
c83fe82 server/authority: fix upsert comments

📊 Changes

18 files changed (+48 additions, -85 deletions)

View changed files

📝 README.md (+5 -8)
📝 bin/src/hickory-dns.rs (+11 -10)
📝 bin/src/prometheus_server.rs (+1 -1)
📝 crates/client/README.md (+1 -1)
📝 crates/resolver/README.md (+1 -1)
📝 crates/server/Cargo.toml (+0 -5)
📝 crates/server/src/authority/auth_lookup.rs (+1 -14)
📝 crates/server/src/authority/catalog.rs (+4 -2)
📝 crates/server/src/authority/message_response.rs (+4 -13)
📝 crates/server/src/server/mod.rs (+8 -5)
📝 crates/server/src/server/request_handler.rs (+1 -1)
📝 crates/server/src/server/response_handler.rs (+2 -6)
📝 crates/server/src/server/timeout_stream.rs (+0 -1)
📝 crates/server/src/store/blocklist.rs (+2 -8)
📝 crates/server/src/store/in_memory/mod.rs (+3 -1)
📝 crates/server/src/store/sqlite/persistence.rs (+2 -3)
📝 scripts/docker_ftest.sh (+0 -1)
📝 tests/test-data/test_configs/sec/gen-keys.sh (+2 -4)

📄 Description

Here's a grab bag of various small documentation changes that I've been collecting as I read through bits of the authoritative server code for other work. Lots of the changes are related to places where arguments were documented in rustdoc comments, but had drifted from the implementations. I also slipped in one very small code change, and tried to kill off some lingering native-tls refs.

I suspect similar efforts would yield good results for the other crates, but for now I've mostly limited my review pass to the authoritative server crate & bin.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hickory-dns/hickory-dns/pull/3071 **Author:** [@cpu](https://github.com/cpu) **Created:** 6/19/2025 **Status:** ✅ Merged **Merged:** 6/20/2025 **Merged by:** [@djc](https://github.com/djc) **Base:** `main` ← **Head:** `cpu-comment-crawl_dev` --- ### 📝 Commits (10+) - [`6622479`](https://github.com/hickory-dns/hickory-dns/commit/6622479f2f3a000b6c48f1255f518b85a583b0b4) hickory-server: update usage opts rustdoc comment - [`d65b25c`](https://github.com/hickory-dns/hickory-dns/commit/d65b25c02b55893d79d14eabef9b1e98b7a27269) scripts: remove reference to non-existent native-tls dir - [`bf36e6f`](https://github.com/hickory-dns/hickory-dns/commit/bf36e6fdac97c6b19ac2bb1a375b3da1156968cb) hickory-dns: remove stale native-tls comments - [`64d2a69`](https://github.com/hickory-dns/hickory-dns/commit/64d2a693e089c658e3a5ecc9d2028b4d95d1c5bd) docs: remove some stale ref's to native-tls - [`6de4857`](https://github.com/hickory-dns/hickory-dns/commit/6de4857bfc4794ba90f82d6c9ce7754ba888e7ad) tests/test-data: replace gen-keys.sh comments - [`e7d5a84`](https://github.com/hickory-dns/hickory-dns/commit/e7d5a84316f5fbe8a5d75418686647a2e917383e) hickory-server: fix prom. server comment typo - [`8da0de6`](https://github.com/hickory-dns/hickory-dns/commit/8da0de65920f166cb760d457936438b912624966) hickory-dns: remove template Cargo.toml comments - [`9ec5fa5`](https://github.com/hickory-dns/hickory-dns/commit/9ec5fa592056053d97c546b35ec8318ae75737e9) server/authority: remove stale lifetime comments - [`6a2d1c5`](https://github.com/hickory-dns/hickory-dns/commit/6a2d1c5a15a3bef1c6d310ee401e7e16bf673204) server/authority: update AnyRecords comment - [`c83fe82`](https://github.com/hickory-dns/hickory-dns/commit/c83fe824a1f23abd60993f6d371bc83ca2e4d4d4) server/authority: fix upsert comments ### 📊 Changes **18 files changed** (+48 additions, -85 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+5 -8) 📝 `bin/src/hickory-dns.rs` (+11 -10) 📝 `bin/src/prometheus_server.rs` (+1 -1) 📝 `crates/client/README.md` (+1 -1) 📝 `crates/resolver/README.md` (+1 -1) 📝 `crates/server/Cargo.toml` (+0 -5) 📝 `crates/server/src/authority/auth_lookup.rs` (+1 -14) 📝 `crates/server/src/authority/catalog.rs` (+4 -2) 📝 `crates/server/src/authority/message_response.rs` (+4 -13) 📝 `crates/server/src/server/mod.rs` (+8 -5) 📝 `crates/server/src/server/request_handler.rs` (+1 -1) 📝 `crates/server/src/server/response_handler.rs` (+2 -6) 📝 `crates/server/src/server/timeout_stream.rs` (+0 -1) 📝 `crates/server/src/store/blocklist.rs` (+2 -8) 📝 `crates/server/src/store/in_memory/mod.rs` (+3 -1) 📝 `crates/server/src/store/sqlite/persistence.rs` (+2 -3) 📝 `scripts/docker_ftest.sh` (+0 -1) 📝 `tests/test-data/test_configs/sec/gen-keys.sh` (+2 -4) </details> ### 📄 Description Here's a grab bag of various small documentation changes that I've been collecting as I read through bits of the authoritative server code for other work. Lots of the changes are related to places where arguments were documented in rustdoc comments, but had drifted from the implementations. I also slipped in one [very small code change](https://github.com/hickory-dns/hickory-dns/pull/3071/commits/afce51a22478bc1d11a2dd6db592be8d0e7c29f6), and tried to kill off some lingering `native-tls` refs. I suspect similar efforts would yield good results for the other crates, but for now I've mostly limited my review pass to the authoritative server crate & bin. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>