From 06f6cd95beca124a54a7346ea2e31b75e1bcfc5a Mon Sep 17 00:00:00 2001 From: onur-ozkan Date: Sun, 12 Nov 2023 13:26:04 +0300 Subject: [PATCH] bootstrap: add doc-comments for `ChangeSeverity` Signed-off-by: onur-ozkan --- src/bootstrap/src/lib.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/bootstrap/src/lib.rs b/src/bootstrap/src/lib.rs index 0351ec53824..00fe4422e5c 100644 --- a/src/bootstrap/src/lib.rs +++ b/src/bootstrap/src/lib.rs @@ -81,7 +81,10 @@ pub struct ChangeInfo { #[derive(Clone, Debug)] pub enum ChangeSeverity { + /// Used when build configurations continue working as before. Info, + /// Used when the default value of an option changes, or support for an option is removed entirely, + /// potentially requiring developers to update their build configurations. Warning, } @@ -96,7 +99,6 @@ impl ToString for ChangeSeverity { /// Keeps track of major changes made to the bootstrap configuration. /// -/// /// If you make any major changes (such as adding new values or changing default values), /// please ensure adding `ChangeInfo` to the end(because the list must be sorted by the merge date) /// of this list.