From c070dd4c0f49326d09ebef80de34c968e823edbc Mon Sep 17 00:00:00 2001
From: utam0k <k0ma@utam0k.jp>
Date: Sun, 14 Nov 2021 20:47:48 +0900
Subject: [PATCH] add some comments about YoukiConfig.

---
 crates/libcontainer/src/config.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/crates/libcontainer/src/config.rs b/crates/libcontainer/src/config.rs
index eea0287e..e54bd8d4 100644
--- a/crates/libcontainer/src/config.rs
+++ b/crates/libcontainer/src/config.rs
@@ -10,8 +10,9 @@ use oci_spec::runtime::{Hooks, Spec};
 
 use crate::utils;
 
-// TODO: comments and examples
-#[derive(Clone, Debug, Deserialize, Serialize)]
+/// A configuration for passing information obtained during container creation to other commands.
+/// Keeping the information to a minimum improves performance.
+#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
 pub struct YoukiConfig {
     pub hooks: Option<Hooks>,
     pub cgroup_path: PathBuf,