fix(doc): use an automatic url link, fix doc links, remove deprecated names in doc (#1493)

Author: lmatz

rust/common/src/hash/dispatcher.rs

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-use super::{HashKey, MAX_FIXED_SIZE_KEY_ELEMENTS};
+use super::HashKey;
 use crate::hash;
 use crate::types::{DataSize, DataType};
 
@@ -60,15 +60,16 @@ pub trait HashKeyDispatcher {
     }
 }
 
+pub const MAX_FIXED_SIZE_KEY_ELEMENTS: usize = 8;
 /// Calculate what kind of hash key should be used given the key data types.
 ///
-/// When any of following conditions is met, we choose [`SerializedKey`]:
+/// When any of following conditions is met, we choose [`crate::hash::SerializedKey`]:
 /// 1. Has variable size column.
 /// 2. Number of columns exceeds [`MAX_FIXED_SIZE_KEY_ELEMENTS`]
 /// 3. Sizes of data types exceed `256` bytes.
 /// 4. Any column's serialized format can't be used for equality check.
 ///
-/// Otherwise we choose smallest [`FixedSizeKey`] whose size can hold all data types.
+/// Otherwise we choose smallest [`crate::hash::FixedSizeKey`] whose size can hold all data types.
 pub fn calc_hash_key_kind(data_types: &[DataType]) -> HashKeyKind {
     if data_types.len() > MAX_FIXED_SIZE_KEY_ELEMENTS {
         return HashKeyKind::KeySerialized;

rust/common/src/hash/key.rs

@@ -40,9 +40,6 @@ use crate::util::hash_util::CRC32FastBuilder;
 /// are encoded from both `t.b, t.c`. If t.b="abc", t.c=1, the hashkey may be
 /// encoded in certain format of ("abc", 1).
 
-/// Max element count in [`FixedSizeKeyWithHashCode`]
-pub const MAX_FIXED_SIZE_KEY_ELEMENTS: usize = 8;
-
 pub trait HashKeySerializer {
     type K: HashKey;
     fn from_hash_code(hash_code: u64) -> Self;
@@ -119,7 +116,7 @@ pub trait HashKey: Clone + Debug + Hash + Eq + Sized + Send + Sync + 'static {
 
 /// Designed for hash keys with at most `N` serialized bytes.
 ///
-/// See [`crate::executor::hash_map::calc_hash_key_kind`]
+/// See [`crate::hash::calc_hash_key_kind`]
 #[derive(Clone, Debug)]
 pub struct FixedSizeKey<const N: usize> {
     hash_code: u64,
@@ -129,7 +126,7 @@ pub struct FixedSizeKey<const N: usize> {
 
 /// Designed for hash keys which can't be represented by [`FixedSizeKey`].
 ///
-/// See [`crate::executor::hash_map::calc_hash_key_kind`]
+/// See [`crate::hash::calc_hash_key_kind`]
 #[derive(Clone, Debug)]
 pub struct SerializedKey {
     key: Vec<Datum>,

rust/storage/src/hummock/iterator/reverse_user.rs

@@ -53,7 +53,7 @@ pub struct ReverseUserIterator<'a> {
 }
 
 impl<'a> ReverseUserIterator<'a> {
-    /// Creates [`UserIterator`] with maximum epoch.
+    /// Creates [`ReverseUserIterator`] with maximum epoch.
     #[cfg(test)]
     pub(crate) fn new(
         iterator: ReverseMergeIterator<'a>,
@@ -62,7 +62,7 @@ impl<'a> ReverseUserIterator<'a> {
         Self::new_with_epoch(iterator, key_range, Epoch::MAX, None)
     }
 
-    /// Creates [`UserIterator`] with given `read_epoch`.
+    /// Creates [`ReverseUserIterator`] with given `read_epoch`.
     pub(crate) fn new_with_epoch(
         iterator: ReverseMergeIterator<'a>,
         key_range: (Bound<Vec<u8>>, Bound<Vec<u8>>),

rust/storage/src/hummock/sstable/block.rs

@@ -189,7 +189,7 @@ impl Default for BlockBuilderOptions {
     }
 }
 
-/// [`BlockV2Writer`] encode and append block to a buffer.
+/// [`BlockBuilder`] encodes and appends block to a buffer.
 pub struct BlockBuilder {
     /// Write buffer.
     buf: BytesMut,

rust/storage/src/hummock/sstable/mod.rs

@@ -41,7 +41,7 @@ const MAGIC: u32 = 0x5785ab73;
 const VERSION: u32 = 1;
 
 #[derive(Clone)]
-/// [`SSTable`] is a handle for accessing SST in [`TableManager`].
+/// [`Sstable`] is a handle for accessing SST.
 pub struct Sstable {
     pub id: u64,
     pub meta: SstableMeta,

rust/storage/src/object/mod.rs

@@ -53,7 +53,7 @@ pub trait ObjectStore: Send + Sync {
     /// If the `block_loc` is None, the whole object will be return.
     /// If objects are PUT using a multipart upload, it’s a good practice to GET them in the same
     /// part sizes (or at least aligned to part boundaries) for best performance.
-    /// https://d1.awsstatic.com/whitepapers/AmazonS3BestPractices.pdf?stod_obj2
+    /// <https://d1.awsstatic.com/whitepapers/AmazonS3BestPractices.pdf?stod_obj2>
     async fn read(&self, path: &str, block_loc: Option<BlockLocation>) -> Result<Bytes>;
 
     async fn readv(&self, path: &str, block_locs: Vec<BlockLocation>) -> Result<Vec<Bytes>>;