chore: scrub #NNN issue references from code comments and nix descriptions
Part of the docs-migration chore (issue #708). Remove GitHub issue numbers from inline comments, option descriptions, and rustdoc — these are contextless noise for anyone reading the code without access to the original discussions. Replace with prose that captures the same rationale directly. No functional change. Build still clean (cargo check passes).
This commit is contained in:
parent
083a100ba1
commit
188f3ea5ec
18 changed files with 131 additions and 151 deletions
|
|
@ -15,8 +15,7 @@ use crate::lifecycle::{self, MANAGER_NAME};
|
|||
/// either runs the work inline (`InitConfig`, sub-second git ops) or
|
||||
/// enqueues it into `rebuild_queue` so the dashboard POST returns
|
||||
/// immediately while the long-running pipeline runs off-thread
|
||||
/// (closes #436 — operator no longer eats a 30-90s spinner on
|
||||
/// `ApplyCommit`).
|
||||
/// (operator no longer blocks on a 30-90s spinner for `ApplyCommit`).
|
||||
///
|
||||
/// Dispatch:
|
||||
/// - `ApplyCommit` → `QueueKind::Rebuild` (~30-90s wall time)
|
||||
|
|
@ -103,9 +102,9 @@ pub async fn approve(coord: Arc<Coordinator>, id: i64) -> Result<()> {
|
|||
}
|
||||
|
||||
/// Worker entry point for `ApprovalKind::ApplyCommit` queue entries.
|
||||
/// Re-fetches the approval row, runs the commit pipeline (same
|
||||
/// shape as the pre-#436 inline path), and fires `ApprovalResolved`
|
||||
/// + the lifecycle event (`Rebuilt` / `Spawned` for first-spawn).
|
||||
/// Re-fetches the approval row, runs the commit pipeline, and fires
|
||||
/// `ApprovalResolved` + the lifecycle event (`Rebuilt` / `Spawned`
|
||||
/// for first-spawn).
|
||||
pub async fn run_approval_apply_commit(
|
||||
coord: &Arc<Coordinator>,
|
||||
queue_entry_id: Option<u64>,
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ pub const SOCKET_FILENAME: &str = "web.sock";
|
|||
/// sub-agent that hasn't flipped the option yet.
|
||||
///
|
||||
/// Renamed from `.bound` (legacy) to match the `hyperhive-` prefix
|
||||
/// convention for all harness-written state files (#838). `build_map`
|
||||
/// convention for all harness-written state files. `build_map`
|
||||
/// checks both names during the transition window so existing containers
|
||||
/// don't lose gateway routing before their next rebuild.
|
||||
pub const READY_MARKER: &str = "hyperhive-socket-bound";
|
||||
|
|
|
|||
|
|
@ -526,8 +526,8 @@ impl Broker {
|
|||
/// ids the harness pulled via `recv_batch`) and `requeue_inflight`
|
||||
/// (which puts inflight-but-unacked rows BACK on the queue). This
|
||||
/// is the destructive "drain everything for this agent" path the
|
||||
/// dashboard surfaces as the side-panel "mark all read" button
|
||||
/// (#559). Backs `POST /api/agent/{name}/mark-all-read`.
|
||||
/// dashboard surfaces as the side-panel "mark all read" button.
|
||||
/// Backs `POST /api/agent/{name}/mark-all-read`.
|
||||
pub fn mark_all_read(&self, recipient: &str) -> Result<u64> {
|
||||
let mut inflight = self.inflight.lock().unwrap();
|
||||
let conn = self.conn.lock().unwrap();
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ pub enum DashboardEvent {
|
|||
/// immediately and runs the `nix flake update` + agent-rebuild
|
||||
/// ripple in a background task — this event lets the META INPUTS
|
||||
/// panel show a disabled "updating…" state for that whole window
|
||||
/// instead of looking idle (issue #259). Emitted by
|
||||
/// instead of looking idle. Emitted by
|
||||
/// `Coordinator::meta_update_guard` / `MetaUpdateGuard::drop` only
|
||||
/// when the active-run count crosses 0, so concurrent updates flip
|
||||
/// the flag exactly once.
|
||||
|
|
@ -198,8 +198,8 @@ impl DashboardEvent {
|
|||
/// Snake-case identifier matching this variant's serde `tag`
|
||||
/// (e.g. `Sent` → `"sent"`, `ContainerStateChanged` →
|
||||
/// `"container_state_changed"`). Lets `/dashboard/stream`'s
|
||||
/// `?kinds=` filter (#408) decide whether to forward a frame
|
||||
/// without paying the JSON-serialise cost first.
|
||||
/// `?kinds=` filter decide whether to forward a frame without
|
||||
/// paying the JSON-serialise cost first.
|
||||
///
|
||||
/// Keep in sync with `#[serde(rename_all = "snake_case", tag =
|
||||
/// "kind")]` on `DashboardEvent` — if a new variant lands above,
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
//! Pre-apply validation for agent `flake.lock` files (closes part of #317).
|
||||
//! Pre-apply validation for agent `flake.lock` files.
|
||||
//!
|
||||
//! Every `request_apply_commit` lands a `proposal/<id>` tag in the
|
||||
//! agent's applied repo before the operator sees the approval. We
|
||||
|
|
@ -8,11 +8,10 @@
|
|||
//! directive in `flake.nix` and would inflate meta's lock with
|
||||
//! duplicates after deploy.
|
||||
//!
|
||||
//! Per mara's scope note on #317 (comment 4189): the check runs on
|
||||
//! the agent repo, not meta, and catches *new* violations only.
|
||||
//! Existing agents whose lock already has duplicates are out of
|
||||
//! scope here and get a coordinated config-change pass via the
|
||||
//! manager instead.
|
||||
//! The check runs on the agent repo, not meta, and catches *new*
|
||||
//! violations only. Existing agents whose lock already has duplicates
|
||||
//! are out of scope here and get a coordinated config-change pass via
|
||||
//! the manager instead.
|
||||
|
||||
use std::collections::BTreeMap;
|
||||
use std::fmt::Write as _;
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
//! sockets, background sweepers. `hivectl` (sibling bin under
|
||||
//! `src/bin/hivectl.rs`) reuses a thin subset (`forge`, `matrix`,
|
||||
//! `lifecycle`) to expose host-side administration verbs — manually
|
||||
//! provisioning forge / matrix users for an agent, etc. (#655).
|
||||
//! provisioning forge / matrix users for an agent, etc.
|
||||
//!
|
||||
//! Every module is re-exported `pub` so anything in the crate is
|
||||
//! addressable from either binary; the lib doesn't have a curated
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ pub fn check_size(label: &str, body: &str) -> Result<(), String> {
|
|||
/// scrolling chunk.
|
||||
pub const STATUS_MAX_CHARS: usize = 200;
|
||||
|
||||
/// Validate a `set_status` payload (#720). Single-line + bounded so
|
||||
/// Validate a `set_status` payload. Single-line + bounded so
|
||||
/// callers can't dump multi-paragraph session reports into the
|
||||
/// dashboard chip. Whitespace trim is done by the caller before the
|
||||
/// store-to-disk step — we run validation on the trimmed form so
|
||||
|
|
@ -70,8 +70,7 @@ pub fn check_status_text(text: &str) -> Result<(), String> {
|
|||
return Ok(());
|
||||
}
|
||||
// Newline / carriage-return: status is a single-line chip on the
|
||||
// dashboard. A multi-line argus session report is the canonical
|
||||
// failure mode from #720.
|
||||
// dashboard. Multi-line session reports should go to a state file.
|
||||
if trimmed.contains('\n') || trimmed.contains('\r') {
|
||||
return Err(
|
||||
"set_status text must be a single line — write multi-line context to \
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@ pub async fn sync_agents(
|
|||
// the gateway picks up at runtime without needing a
|
||||
// nixos-rebuild. The gateway container bind-mounts
|
||||
// /var/lib/hyperhive/ and a systemd path unit fires
|
||||
// `nginx -s reload` when this file changes (#869). Same
|
||||
// `nginx -s reload` when this file changes. Same
|
||||
// best-effort + non-fatal shape.
|
||||
if let Err(e) = crate::gateway_nginx::write(&agent_names) {
|
||||
tracing::warn!(error = ?e, "gateway_nginx::write failed (non-fatal)");
|
||||
|
|
|
|||
|
|
@ -189,7 +189,7 @@ async fn dispatch(req: &HostRequest, coord: Arc<Coordinator>) -> HostResponse {
|
|||
HostRequest::SetParent { child, new_parent } => {
|
||||
tracing::info!(%child, ?new_parent, "set_parent");
|
||||
// `reparent_with_notify` wraps `topology::set_parent`
|
||||
// with the three notification messages (#743) + the
|
||||
// with the three notification messages + the
|
||||
// ContainerView rescan. Idempotent same-parent calls
|
||||
// skip both the messages and the disk write per the
|
||||
// topology fast-path.
|
||||
|
|
|
|||
Loading…
Reference in a new issue