Doc updates

src/db/db/gsiDeclDbLog.cc

@@ -46,10 +46,10 @@ Class<db::LogEntryData> decl_dbNetlistDeviceExtractorError ("db", "LogEntryData"
   ) +
   gsi::method ("cell_name=", &db::LogEntryData::set_cell_name, gsi::arg ("cell_name"),
     "@brief Sets the cell name.\n"
-    "The cell name is the name of the layout cell which was treated. This is "
+    "The cell (or circuit) name specifies the cell or circuit the "
-    "also the name of the circuit the device should have appeared in (it may be dropped because of this error). "
+    "log entry is related to. If the log entry is an error or "
-    "If netlist hierarchy manipulation happens however, the circuit may not exist "
+    "warning generated during device extraction, the cell name is "
-    "any longer or may be renamed."
+    "the circuit the device should have appeared in."
   ) +
   gsi::method ("geometry", &db::LogEntryData::geometry,
     "@brief Gets the geometry.\n"
@@ -57,7 +57,7 @@ Class<db::LogEntryData> decl_dbNetlistDeviceExtractorError ("db", "LogEntryData"
   ) +
   gsi::method ("geometry=", &db::LogEntryData::set_geometry, gsi::arg ("polygon"),
     "@brief Sets the geometry.\n"
-    "The geometry is optional. If given, a marker will be shown when selecting this error."
+    "The geometry is optional. If given, a marker may be shown when selecting this error."
   ) +
   gsi::method ("category_name", &db::LogEntryData::category_name,
     "@brief Gets the category name.\n"
@@ -67,7 +67,7 @@ Class<db::LogEntryData> decl_dbNetlistDeviceExtractorError ("db", "LogEntryData"
     "@brief Sets the category name.\n"
     "The category name is optional. If given, it specifies a formal category name. Errors with the same "
     "category name are shown in that category. If in addition a category description is specified "
-    "(see \\category_description), this description will be displayed as the title of."
+    "(see \\category_description), this description will be displayed as the title."
   ) +
   gsi::method ("category_description", &db::LogEntryData::category_description,
     "@brief Gets the category description.\n"
@@ -91,7 +91,7 @@ Class<db::LogEntryData> decl_dbNetlistDeviceExtractorError ("db", "LogEntryData"
   "for indicating some location or error marker."
   "\n"
   "The original class used to be \"NetlistDeviceExtractorError\" which had been introduced in version 0.26. "
-  "It was generalized and renamed in version 0.28.13 as it was basically not useful as a seperate class."
+  "It was generalized and renamed in version 0.28.13 as it was basically not useful as a separate class."
 );
 
 gsi::Enum<db::Severity> decl_Severity ("db", "Severity",

src/doc/doc/manual/lvs_connect.xml

@@ -102,19 +102,21 @@ connect(metal2, metal2_labels)</pre>
   <p>
   Implicit connections can be useful to supply preliminary connections
   which are supposed to be created higher up in the hierarchy:
-  Imagine a circuit which a big power net for example. When the layout
+  Imagine a circuit with a big power net for example. When the layout
-  is made, the power net may not be completely connected yet because the 
+  is made, the power net may not be completely connected yet, because the 
   plan is to connect all parts of this power net later when the
   cell is integrated. In this situation, the 
-  subcircuit cell itself won't be LVS clean because the power net is a single
+  subcircuit cell itself won't be LVS clean, because the power net is a single
   net schematic-wise, but exist as multiple nets layout-wise. This prevents
   bottom-up verification - a very useful technique to achieve LVS clean 
-  layouts.
+  layouts. It also prevents matching in general, as the layout cell will
+  have two pins while the schematic subcircuit has only one. In this case, 
+  the cell and subcircuit will never match.
   </p>
 
   <p>
   To allow verification of such a cell, "implicit connections" can be
-  made by giving the net parts the same name through labels and assume
+  made by giving the net parts the same name through labels and assuming
   these parts are connected: 
   for example to specify implicit connections between all parts of a "VDD" net,
   place a label "VDD" on each part and include the following statement
@@ -126,9 +128,16 @@ connect(metal2, metal2_labels)</pre>
   <p>
   "connect_implicit" (see <a href="/about/drc_ref_global.xml#connect_implicit">connect_implicit</a>)
   can be present multiple times to make many of such connections.
-  Implicit connections will only be made on the topmost circuit to prevent false verification results. 
+  Implicit connections are accepted on top level, but a warning is issued, indicating
-  Be careful not to use this option in a final verification of a full design as power net 
+  that the connection needs to be made further up in the hierarchy. 
-  opens may pass unnoticed.
+  In a subcircuit, implicit connections are required to be connected on the
+  next level of hierarchy - either physically or by another implicit connection.
+  This way, a missing physical connection does not escape and at least a warning
+  is issued if the connection is still not made on top level.
+  </p>
+
+  <p>
+  This feature is also called "must connect" nets in other systems.
   </p>
 
   <p>
@@ -142,7 +151,8 @@ connect(metal2, metal2_labels)</pre>
   This will connect all nets labelled with "VDD1" for example or those labelled
   with "VDD_5V". However, this statement will only connect "VDD1" with "VDD1",
   <b>not</b> nets with different labels. I.e. it will not connect "VDD1" with "VDD2"
-  labels.
+  labels. To make connections between differently named nets, use "explicit connections"
+  (see below).
   </p>
 
   <p>
@@ -151,30 +161,22 @@ connect(metal2, metal2_labels)</pre>
   </p>
 
   <p>
-  The standard method "connect_implicit" will only act on top-level cells.
+  The above examples of "connect_implicit" apply to all cells. The statement
-  However, sometimes the construction of certain library cells requires 
+  can be made cell specific, by giving a cell name glob pattern for the 
-  connecting nets inside subcells. For example, memory cells are often made
+  first argument, followed by the net name pattern.
-  in a way that their common rails are exposed on different sides but 
+  </p>
-  not connected internally. Formally, those cells need to be described by
+  
-  circuits with multiple pins in the schematic. As the cells are only used
+  <p>
-  in certain contexts where these rails are connected, it's sufficient to 
+  The following statement will connect all nets labelled with "VDD"
-  specify a single pin and connect the rails inside the subcells if labelled
-  properly. The following statement will connect all nets labelled with "VDD"
   from the "MEMCELL" subcell:
   </p>
 
   <pre>connect_implicit("MEMCELL", "VDD")</pre>
 
   <p>
-  If MEMCELL is the top cell, the single-argument, unspecific "connect_implicit"
+  The rule is applied to all cells matching the glob pattern in the first argument.
-  rule is applied, unless no such rule is given. In other words: the unspecific
+  Again, the "connect_implicit" rule may be given multiple times. 
-  rule has priority for the top cell.
+  In this case, all matching occurrences act together.
-  </p>
-
-  <p>
-  The cell argument can be a glob-style pattern. In this case, the rule is
-  applied to all matching cells. Again, the "connect_implicit" rule may be 
-  given multiple times. In this case, all matching occurances act together.
   </p>
 
   <p>
@@ -217,12 +219,10 @@ connect(metal2, metal2_labels)</pre>
   </p>
 
   <p>
-  To align layout and schematics, bulk and VSS pins can be connected
+  To align layout and schematic, bulk and VSS pins can be connected
   explicitly. Same for n-well and VDD.
-  There is a certain risk to forget making these connections later. 
+  This scheme is similar to the "connect_implicit" scheme explained
-  But this risk can be mitigated by implementing DRC rules which
+  above, but acts on differently named nets.
-  demand at least one tie-down diode for each isolated n-well island
-  or the bulk.
   </p>
 
   <p>
@@ -230,7 +230,7 @@ connect(metal2, metal2_labels)</pre>
   bulk have proper names. For the n-well this can be done by creating
   labels on the n-well islands giving them a proper name - e.g. "NWELL".
   The bulk isn't a real layout layer with polygons on it. Using "connect_global"
-  will both connect everthing on this layer and give it a name.
+  will both connect everything on this layer and give it a name.
   </p>
 
   <p>
@@ -242,17 +242,36 @@ connect(metal2, metal2_labels)</pre>
 connect_explicit("INV", [ "BULK", "VSS" ])
 </pre>
 
+  <p>
+  Note that this rule will form a new net called "BULK,VSS" combining both
+  subnets.
+  </p>
+
   <p>
   The cell name can be a pattern. For example "INV*" will apply this rule on all 
   cells starting with "INV".
-  The cell is not mandatory: if it is omitted, the rule is applied to top level only
+  The cell pattern is not mandatory: if it is omitted, the rule is applied to all 
-  to avoid introducing rules in subcells where they would mask layout errors.
+  cells.
+  </p>
+
+  <p>
+  Like implicit connections, explicit connections are checked for being made
+  on the next level of hierarchy, either physically or by another explicit or
+  implicit connection. 
+  This feature is also called "must connect" nets in other systems.
   </p>
 
   <p>
   An explicit connection will also imply implicit connections on the nets 
   listed in the net names. So in the example above, different pieces of "VSS"
-  are connected even if they are not physically connected.
+  are connected even if they are not physically connected. Again, it is checked
+  that these connections are made later up in the hierarchy.
+  </p>
+
+  <p>
+  Again, the "connect_explicit" statements must be given before the netlist is 
+  extracted. Typically this happens before or shortly after "connect"
+  statements.
   </p>
 
 </doc>

src/edt/edt/edtPartialService.cc

@@ -2989,7 +2989,7 @@ PartialService::partial_select (const db::DBox &box, lay::Editable::SelectionMod
       shape_flags |= db::ShapeIterator::Polygons;
     }
     if (edt::paths_enabled ()) {
-      //  Note: points, edges and edge pairs don't have seperate entires, so
+      //  Note: points, edges and edge pairs don't have separate entires, so
       //  we count them as paths here
       shape_flags |= db::ShapeIterator::Paths;
       shape_flags |= db::ShapeIterator::Edges;

testdata/ruby/dbLayoutToNetlist.rb

@@ -1011,6 +1011,20 @@ END
 
   end
 
+  def test_21_LogAPI
+
+    l2n = RBA::LayoutToNetlist::new
+    l2n.read(File.join($ut_testsrc, "testdata", "algo", "l2n_reader_au_6.l2n"))
+
+    le = l2n.each_log_entry.collect { |s| s.to_s }
+    assert_equal(le.size, 4)
+    assert_equal(le[0].to_s, "info")
+    assert_equal(le[1].to_s, "[cat description] In cell cell_name: info, shape: (1,1;2,2;3,1)")
+    assert_equal(le[2].to_s, "warning")
+    assert_equal(le[3].to_s, "error")
+
+  end
+
 end
 
 load("test_epilogue.rb")