Document cyclic dependency.

To be fixed later, but this way it is already documented.
(what needs to be done is probably break out the libraries
in the BUILD file better).

Signed-off-by: Henner Zeller <[email protected]>

Author: hzeller

src/dbSta/BUILD

@@ -9,6 +9,13 @@ package(
     features = ["layering_check"],
 )
 
+# TODO: there is a cyclic dependency between
+# some of these. dbSta depends on dbNetwork and
+# dbSdcNetwork, but these would need to include
+# dbSta.hh ...
+# So this probably needs to be broken into more
+# libraries.
+
 cc_library(
     name = "dbSta",
     srcs = [

src/dbSta/src/dbNetwork.cc

@@ -68,6 +68,11 @@ Recommended conclusion: use map for concrete cells. They are invariant.
 #include "sta/Search.hh"
 #include "utl/Logger.h"
 
+// Circular dependency! We need this header, but that
+// is provided by :dbSta which in turn depends
+// :dbNetwork ...
+// #include "db_sta/dbSta.hh"
+
 namespace sta {
 
 using utl::ORD;

src/dbSta/src/dbSdcNetwork.cc

@@ -13,6 +13,11 @@
 #include "sta/ParseBus.hh"
 #include "sta/PatternMatch.hh"
 
+// Circular dependency! We would need this for
+// e.g. sta::Cell, but that requires to depend on :dbSta
+// which in turn depends on :dbStaNetwork ...
+// #include "db_sta/dbSta.hh"
+
 namespace sta {
 
 static std::string escapeDividers(const char* token, const Network* network);