From e49dcc16e33df7601106092d1127167020805a43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Ber=C3=A1nek?= Date: Mon, 30 Jan 2023 09:19:45 +0100 Subject: [PATCH] Add comment about unifying types to Profile --- collector/src/benchmark/profile.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/collector/src/benchmark/profile.rs b/collector/src/benchmark/profile.rs index 44cbf6a8f..f9b29b2f6 100644 --- a/collector/src/benchmark/profile.rs +++ b/collector/src/benchmark/profile.rs @@ -1,3 +1,10 @@ +/// Type of compilation used for benchmarking/profiling. +// Note: This type is very similar to the definition of a profile in the database crate. +// However, these types should not be unified, as they serve slightly different purposes. +// This type is used for specifying profiles to be benchmarked using the CLI, which is not relevant +// to the database crate. +// In general, the database versions of types used in the collector should be considered a DB +// implementation detail, as they may change when we alter database layout. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ArgEnum, serde::Deserialize)] #[clap(rename_all = "PascalCase")] pub enum Profile {