From 156237d55332a9a5567e99716e9d78e4e743a5d0 Mon Sep 17 00:00:00 2001
From: Yuchen Liang <yuchen@neon.tech>
Date: Fri, 11 Oct 2024 17:30:49 -0400
Subject: [PATCH] add more comments

Signed-off-by: Yuchen Liang <yuchen@neon.tech>
---
 .../src/virtual_file/owned_buffers_io/aligned_buffer/buffer.rs | 1 +
 .../virtual_file/owned_buffers_io/aligned_buffer/buffer_mut.rs | 3 ++-
 .../src/virtual_file/owned_buffers_io/aligned_buffer/raw.rs    | 2 +-
 3 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer.rs b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer.rs
index 20eceebe87..6b55350910 100644
--- a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer.rs
+++ b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer.rs
@@ -5,6 +5,7 @@ use std::{
 
 use super::{alignment::Alignment, raw::RawAlignedBuffer};
 
+/// An shared, immutable aligned buffer type.
 pub struct AlignedBuffer<A: Alignment> {
     /// Shared raw buffer.
     raw: Arc<RawAlignedBuffer<A>>,
diff --git a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer_mut.rs b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer_mut.rs
index 283d816ed5..c878ab14f8 100644
--- a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer_mut.rs
+++ b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/buffer_mut.rs
@@ -6,6 +6,7 @@ use super::{
     raw::RawAlignedBuffer,
 };
 
+/// A mutable aligned buffer type.
 #[derive(Debug)]
 pub struct AlignedBufferMut<A: Alignment> {
     raw: RawAlignedBuffer<A>,
@@ -207,7 +208,7 @@ fn panic_advance(idx: usize, len: usize) -> ! {
     );
 }
 
-/// Safety: [`IoBufferMut`] has exclusive ownership of the io buffer,
+/// Safety: [`AlignedBufferMut`] has exclusive ownership of the io buffer,
 /// and the location remains stable even if [`Self`] is moved.
 unsafe impl<A: Alignment> tokio_epoll_uring::IoBuf for AlignedBufferMut<A> {
     fn stable_ptr(&self) -> *const u8 {
diff --git a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/raw.rs b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/raw.rs
index d9ef8d72f5..6c26dec0db 100644
--- a/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/raw.rs
+++ b/pageserver/src/virtual_file/owned_buffers_io/aligned_buffer/raw.rs
@@ -16,7 +16,7 @@ unsafe impl Send for AlignedBufferPtr {}
 // SAFETY: We gurantees no one besides `IoBufferPtr` itself has the raw pointer.
 unsafe impl Sync for AlignedBufferPtr {}
 
-/// An aligned buffer type used for I/O.
+/// An aligned buffer type.
 #[derive(Debug)]
 pub struct RawAlignedBuffer<A: Alignment> {
     ptr: AlignedBufferPtr,