From 76fe71ebd0d4a56e4d59163393067026dbe6fe2e Mon Sep 17 00:00:00 2001
From: Johnny <johnnyko@google.com>
Date: Wed, 23 Aug 2023 10:13:32 +0800
Subject: [PATCH] sim: provide a signal constructor with an init_state

Add more description to the code

Change-Id: Iff8fb20762baa0c9d0b7e5f24fb8769d7e198b5c
---
 src/sim/signal.hh | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/sim/signal.hh b/src/sim/signal.hh
index 398da9e711..b94618a9c3 100644
--- a/src/sim/signal.hh
+++ b/src/sim/signal.hh
@@ -79,6 +79,7 @@ class SignalSinkPort : public Port
         _source = dynamic_cast<SignalSourcePort<State> *>(&peer);
         fatal_if(!_source, "Attempt to bind signal pin %s to "
                 "incompatible pin %s", name(), peer.name());
+        // The state of sink has to match the state of source.
         _state = _source->state();
         Port::bind(peer);
     }
@@ -104,6 +105,7 @@ class SignalSourcePort : public Port
         _state = {};
     }
 
+    // Give an initial value to the _state instead of using a default value.
     SignalSourcePort(const std::string &_name, PortID _id,
                      const State &init_state)
         : SignalSourcePort(_name, _id)