Generated documentation

src/doc/doc/about/drc_ref_global.xml

@@ -1175,6 +1175,24 @@ four-terminal MOS transistor.
 See <class_doc href="DeviceExtractorMOS4Transistor">DeviceExtractorMOS4Transistor</class_doc> for more details
 about this extractor (non-strict mode applies for 'mos4').
 </p>
+<a name="name"/><h2>"name" - Assigns a name to a layer for reference in the LVS database</h2>
+<keyword name="name"/>
+<p>Usage:</p>
+<ul>
+<li><tt>name(layer, name)</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_netter.xml#name">Netter#name</a> for a description of that function.
+</p>
+<a name="name_prefix"/><h2>"name_prefix" - Specifies the layer name prefix for auto-generated layer names</h2>
+<keyword name="name_prefix"/>
+<p>Usage:</p>
+<ul>
+<li><tt>name_prefix(prefix)</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_netter.xml#name_prefix">Netter#name_prefix</a> for a description of that function.
+</p>
 <a name="netlist"/><h2>"netlist" - Obtains the extracted netlist from the default <a href="/about/drc_ref_netter.xml">Netter</a></h2>
 <keyword name="netlist"/>
 <p>

src/doc/doc/about/drc_ref_netter.xml

@@ -422,6 +422,49 @@ but no error is raised.
 The <class_doc href="LayoutToNetlist">LayoutToNetlist</class_doc> object provides access to the internal details of
 the netter object.
 </p>
+<a name="name"/><h2>"name" - Assigns a name to a layer</h2>
+<keyword name="name"/>
+<p>Usage:</p>
+<ul>
+<li><tt>name(layer, name)</tt></li>
+</ul>
+<p>
+Layer names are listed in the LayoutToNetlist (L2N) or LVS database. They
+are used to identify the layers, the net or device terminal geometries are
+on. It is usual to have computed layers, so it is necessary to indicate the
+purpose of the layer for later reuse of the geometries.
+</p><p>
+It is a good practice to assign names to computed and original layers, 
+for example:
+</p><p>
+<pre>
+poly = input(...)
+poly_resistor = input(...)
+
+poly_wiring = poly - poly_resistor
+name(poly_wiring, "poly_wiring")
+</pre>
+</p><p>
+Names must be assigned before the layers are used for the first time
+in <a href="#connect">connect</a>, <a href="#soft_connect">soft_connect</a>, <a href="#connect_global">connect_global</a>, <a href="#soft_connect_global">soft_connect_global</a> and 
+extract_devices statements. 
+</p><p>
+If layers are not named, they will be given a name made from the 
+<a href="#name_prefix">name_prefix</a> and an incremental number when the layer is used for the
+first time. 
+</p><p>
+<a href="#name">name</a> can only be used once on a layer and the layer names must be 
+unique (not taken by another layer).
+</p>
+<a name="name_prefix"/><h2>"name_prefix" - Specifies the name prefix for auto-generated layer names</h2>
+<keyword name="name_prefix"/>
+<p>Usage:</p>
+<ul>
+<li><tt>name_prefix(prefix)</tt></li>
+</ul>
+<p>
+See <link href="#name"/> for details. The default prefix is "l".
+</p>
 <a name="netlist"/><h2>"netlist" - Gets the extracted netlist or triggers extraction if not done yet</h2>
 <keyword name="netlist"/>
 <p>Usage:</p>

src/doc/doc/about/lvs_ref_netter.xml

@@ -396,6 +396,9 @@ the schematic netlist for all circuits starting with "INV":
 same_nets("INV*", "A*")
 </pre>
 </p><p>
+A plain "*" for the net pattern forces all (named) nets to be equivalent between layout and schematic. 
+Unnamed nets from the extracted netlist are not considered - i.e. nets without a label.
+</p><p>
 After using this function, the compare algorithm will consider these nets equivalent.
 Use this method to provide hints for the comparer in cases which are difficult to
 resolve otherwise.
@@ -404,6 +407,16 @@ circuit_a and net_a are for the layout netlist, circuit_b and net_b for the sche
 Names are case sensitive for layout-derived netlists and case-insensitive for SPICE schematic netlists.
 </p><p>
 Use this method andwhere in the script before the <a href="#compare">compare</a> call.
+</p><p>
+Multiple calls of "same_nets" can be used. The calls are effective in the order
+the are given. For example, the following sequence specifies equivalence of all
+equally named nets, with the exception of "A" and "B" which are equivalent to each other
+inside cell "ND2", despite their different name:
+</p><p>
+<pre>
+same_nets("*", "*")
+same_nets("ND2", "A", "B")
+</pre>
 </p>
 <a name="same_nets!"/><h2>"same_nets!" - Establishes an equivalence between the nets with matching requirement</h2>
 <keyword name="same_nets!"/>
@@ -416,6 +429,22 @@ Use this method andwhere in the script before the <a href="#compare">compare</a>
 <p>
 This method is equivalent to <a href="#same_nets">same_nets</a>, but requires identity of the given nets.
 If the specified nets do not match, an error is reported.
+</p><p>
+For example, this global specification requires all named nets from the
+layout to have an equivalent net in the schematic and those nets need to be 
+identical for all circuits:
+</p><p>
+<pre>
+same_nets!("*", "*")
+</pre>
+</p><p>
+The following specification requires "A" and "B" to be identical in
+circuit "ND2". It is not an error if either "A" does not exist in the
+layout or "B" does not exist in the schematic:
+</p><p>
+<pre>
+same_nets!("ND2", "A", "B")
+</pre>
 </p>
 <a name="schematic"/><h2>"schematic" - Gets, sets or reads the reference netlist</h2>
 <keyword name="schematic"/>