Skip to content

[api] Fix some doc comments - #11196

Merged
david-crespo merged 3 commits into
mainfrom
api-doc-comment-fixes
Aug 29, 2026
Merged

[api] Fix some doc comments#11196
david-crespo merged 3 commits into
mainfrom
api-doc-comment-fixes

Conversation

@david-crespo

@david-crespo david-crespo commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Closes #9359, closes #4942, closes #7649, and redoes #9871.

Also say "network interface" instead of "OPTE" in the jumbo frames doc comments — noticed in the discussion on oxidecomputer/oxide.rs#1525, where the OPTE wording had been copied into the CLI. "Primary network interface" is accurate: the jumbo MTU is applied only to the primary NIC's OPTE port, and only when both the fleet flag and the instance bit are set.

/// Effective MTU for an instance's primary OPTE port. Jumbo frames are only
/// applied when both the fleet-wide opt-in is enabled and the per-instance bit
/// is set; otherwise this returns `None` and OPTE applies the default MTU.
fn primary_nic_mtu_for_jumbo_frames(
instance_jumbo_frames_enabled: bool,
fleet_jumbo_frames_opt_in_enabled: bool,
) -> Option<u32> {
if instance_jumbo_frames_enabled && fleet_jumbo_frames_opt_in_enabled {
Some(omicron_common::address::EXTERNAL_JUMBO_FRAMES_MTU)
} else {
None
}
}

- Fix silo_user_list/silo_user_view summaries that wrongly said "built-in
  (system) users" (#9359)
- Say "network interface" instead of "OPTE" in jumbo frames doc comments
- Clarify that audit log start_time/end_time filter on time_completed
  (redo of #9871 on main)
- Add missing doc comment on SiloCreate.discoverable and reword the
  matching Silo view comment (#4942)
@david-crespo
david-crespo enabled auto-merge (squash) August 28, 2026 22:25
@david-crespo
david-crespo merged commit 8b78a77 into main Aug 29, 2026
20 checks passed
@david-crespo
david-crespo deleted the api-doc-comment-fixes branch August 29, 2026 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant