Updated DRC doc.

src/drc/drc/built-in-macros/drc.lym

@@ -3495,10 +3495,12 @@ CODE
     # some operations such as clipping are not fully supported for texts. Also, texts will
     # vanish in most polygon operations such as booleans etc.
     #
-    # Texts can alway be selected by using the \texts method.
+    # Texts can later be selected on the layer returned by "input" with the \Layer#texts method.
     #
     # If you don't want to see texts, use \polygons to create an input layer with polygon data
     # only. If you only want to see texts, use \labels to create an input layer with texts only.
+    #
+    # Use the global version of "input" without a source object to address the default source.
     
     def input(*args)
       layers = parse_input_layers(*args)
@@ -3517,6 +3519,8 @@ CODE
     # 
     # This method is identical to \input, but takes only texts from the given input
     # layer.
+    #
+    # Use the global version of "labels" without a source object to address the default source.
     
     def labels(*args)
       layers = parse_input_layers(*args)
@@ -3536,6 +3540,8 @@ CODE
     # Those are boxes, paths and real polygons.
     # 
     # This method is identical to \input with respect to the options supported.
+    #
+    # Use the global version of "polygons" without a source object to address the default source.
     
     def polygons(*args)
       layers = parse_input_layers(*args)

src/lay/lay/doc/about/drc_ref_global.xml

@@ -87,6 +87,15 @@ l1 = input(1, 0)
 <p>
 See <a href="/about/drc_ref_netter.xml#connect">Netter#connect</a> for a description of that function.
 </p>
+<h2>"connect_global" - Specifies a connection to a global net</h2>
+<keyword name="connect_global"/>
+<a name="connect_global"/><p>Usage:</p>
+<ul>
+<li><tt>connect_global(l, name)</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_netter.xml#connect_global">Netter#connect_global</a> for a description of that function.
+</p>
 <h2>"dbu" - Gets or sets the database unit to use</h2>
 <keyword name="dbu"/>
 <a name="dbu"/><p>Usage:</p>
@@ -164,6 +173,15 @@ Similar to <a href="#log">log</a>, but the message is printed formatted as an er
 <p>
 See <a href="/about/drc_ref_source.xml#extent">Source#extent</a> for a description of that function.
 </p>
+<h2>"extract_devices" - Extracts devices for a given device extractor and device layer selection</h2>
+<keyword name="extract_devices"/>
+<a name="extract_devices"/><p>Usage:</p>
+<ul>
+<li><tt>extract_devices(extractor, layer_hash)</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_netter.xml#extract_devices">Netter#extract_devices</a> for a description of that function
+</p>
 <h2>"flat" - Disables tiling mode</h2>
 <keyword name="flat"/>
 <a name="flat"/><p>Usage:</p>
@@ -191,7 +209,9 @@ In non-verbose more, nothing is printed.
 <li><tt>input(args)</tt></li>
 </ul>
 <p>
-See <a href="/about/drc_ref_source.xml#input">Source#input</a> for a description of that function.
+See <a href="/about/drc_ref_source.xml#input">Source#input</a> for a description of that function. This method will fetch
+polygons and labels. See <a href="#polygons">polygons</a> and <a href="#labels">labels</a> for more specific versions of
+this method.
 </p>
 <h2>"is_deep?" - Returns true, if in deep mode</h2>
 <keyword name="is_deep?"/>
@@ -205,6 +225,15 @@ See <a href="/about/drc_ref_source.xml#input">Source#input</a> for a description
 <ul>
 <li><tt>is_tiled?</tt></li>
 </ul>
+<h2>"l2n_data" - Gets the internal <class_doc href="LayoutToNetlist">LayoutToNetlist</class_doc> object for the default <a href="#Netter">Netter</a></h2>
+<keyword name="l2n_data"/>
+<a name="l2n_data"/><p>Usage:</p>
+<ul>
+<li><tt>l2n_data</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_netter.xml#l2n_data">Netter#l2n_data</a> for a description of that function
+</p>
 <h2>"labels" - Gets the labels (text) from an original layer</h2>
 <keyword name="labels"/>
 <a name="labels"/><p>Usage:</p>
@@ -281,6 +310,24 @@ verbose mode is enabled.
 After using that method, the log output is sent to the 
 given file instead of the logger window or the terminal.
 </p>
+<h2>"make_layer" - Creates an empty polygon layer based on the hierarchical scheme selected</h2>
+<keyword name="make_layer"/>
+<a name="make_layer"/><p>Usage:</p>
+<ul>
+<li><tt>make_layer</tt></li>
+</ul>
+<p>
+The intention of this method is to provide an empty polygon layer based on the
+hierarchical scheme selected. This will create a new layer with the hierarchy
+of the current layout in deep mode and a flat layer in flat mode.
+This method is similar to <a href="#polygon_layer">polygon_layer</a>, but the latter does not create
+a hierarchical layer. Hence the layer created by <a href="#make_layer">make_layer</a> is suitable
+for use in device extraction for example, while the one
+delivered by <a href="#polygon_layer">polygon_layer</a> is not.
+</p><p>
+On the other hand, a layer created by the <a href="#make_layer">make_layer</a> method is not intended to be
+filled with <a href="/about/drc_ref_layer.xml#insert">Layer#insert</a>.
+</p>
 <h2>"netter" - Creates a new netter object</h2>
 <keyword name="netter"/>
 <a name="netter"/><p>Usage:</p>
@@ -363,6 +410,17 @@ This function creates a polygon object. The arguments are the same than for the
 <p>
 The intention of that method is to create an empty layer which can be 
 filled with polygon-like objects using <a href="/about/drc_ref_layer.xml#insert">Layer#insert</a>.
+A similar method which creates a hierarchical layer in deep mode is 
+<a href="#make_layer">make_layer</a>. This other layer is better suited for use with device extraction.
+</p>
+<h2>"polygons" - Fetches the polygons (or shapes that can be converted to polygons) from the specified input from the default source</h2>
+<keyword name="polygons"/>
+<a name="polygons"/><p>Usage:</p>
+<ul>
+<li><tt>polygons(args)</tt></li>
+</ul>
+<p>
+See <a href="/about/drc_ref_source.xml#polygons">Source#polygons</a> for a description of that function.
 </p>
 <h2>"report" - Specifies a report database for output</h2>
 <keyword name="report"/>

src/lay/lay/doc/about/drc_ref_netter.xml

@@ -137,7 +137,7 @@ errors = antenna_check(gate, metal1, 50.0, [ diode, 10.0 ])
 Multiple diode specifications are allowed. Just add them 
 to the antenna_check call.
 </p><p>
-The error shapes produced by the antenna check are a copy
+The error shapes produced by the antenna check are copies
 of the metal shapes on the metal layers of each network 
 violating the antenna rule.
 </p>
@@ -171,4 +171,63 @@ joins.
 Connections are accumulated. The connections defined so far
 can be cleared with <a href="#clear_connections">clear_connections</a>.
 </p>
+<h2>"connect_global" - Connects a layer with a global net</h2>
+<keyword name="connect_global"/>
+<a name="connect_global"/><p>Usage:</p>
+<ul>
+<li><tt>connect_global(l, name)</tt></li>
+</ul>
+<p>
+Connects the shapes from the given layer l to a global net with the given name.
+Global nets are common to all cells. Global nets automatically connect to parent
+cells throughs implied pins. An example is the substrate (bulk) net which connects
+to shapes belonging to tie-down diodes.
+</p>
+<h2>"extract_devices" - Extracts devices based on the given extractor class, name and device layer selection</h2>
+<keyword name="extract_devices"/>
+<a name="extract_devices"/><p>Usage:</p>
+<ul>
+<li><tt>extract_devices(extractor, layer_hash)</tt></li>
+</ul>
+<p>
+Runs the device extraction for given device extractor class.
+</p><p>
+The device extractor is either an instance of one of the predefined extractor
+classes (e.g. <class_doc href="DeviceExtractorMOS4Transistor">DeviceExtractorMOS4Transistor</class_doc>) or a custom class. It provides the
+algorithms for deriving the device parameters from the device geometry. It needs 
+several device recognition layers which are passed in the layer hash.
+</p><p>
+Each device class (e.g. n-MOS/p-MOS or high Vt/low Vt) needs it's own instance
+of device extractor. The device extractor beside the algorithm and specific 
+extraction settings defines the name of the device to be built.
+</p><p>
+The layer hash is a map of device type specific functional names (key) and
+polygon layers (value). Here is an example:
+</p><p>
+<pre>
+deep
+
+nwell   = input(1, 0)
+active  = input(2, 0)
+poly    = input(3, 0)
+bulk    = make_layer   # renders an empty layer used for putting the terminals on
+
+nactive = active - nwell      # active area of NMOS
+nsd     = nactive - poly      # source/drain area
+gate    = nactive &amp; poly  # gate area
+
+mos4_ex = <class_doc href="DeviceExtractorMOS4Transistor">DeviceExtractorMOS4Transistor</class_doc>::new("NMOS4")
+extract_devices(mos4_ex, { :SD =&gt; nsd, :G =&gt; gate, :P =&gt; poly, :W =&gt; bulk })
+</pre>
+</p>
+<h2>"l2n_data" - Gets the internal <class_doc href="LayoutToNetlist">LayoutToNetlist</class_doc> object</h2>
+<keyword name="l2n_data"/>
+<a name="l2n_data"/><p>Usage:</p>
+<ul>
+<li><tt>l2n_data</tt></li>
+</ul>
+<p>
+The <class_doc href="LayoutToNetlist">LayoutToNetlist</class_doc> object provides access to the internal details of
+the netter object.
+</p>
 </doc>

src/lay/lay/doc/about/drc_ref_source.xml

@@ -94,6 +94,19 @@ Some filter expressions are:
 <li><tt>METAL (17/0) </tt>: A layer named "METAL" or layer 17, datatype 0 (for GDS, which does
 not have names)</li>
 </ul>
+</p><p>
+Layers created with "input" contain both texts and polygons. There is a subtle
+difference between flat and deep mode: in flat mode, texts are not visible in polygon
+operations. In deep mode, texts appear as small 2x2 DBU rectangles. In flat mode, 
+some operations such as clipping are not fully supported for texts. Also, texts will
+vanish in most polygon operations such as booleans etc.
+</p><p>
+Texts can later be selected on the layer returned by "input" with the <a href="/about/drc_ref_layer.xml#texts">Layer#texts</a> method.
+</p><p>
+If you don't want to see texts, use <a href="#polygons">polygons</a> to create an input layer with polygon data
+only. If you only want to see texts, use <a href="#labels">labels</a> to create an input layer with texts only.
+</p><p>
+Use the global version of "input" without a source object to address the default source.
 </p>
 <h2>"labels" - Gets the labels (texts) from an input layer</h2>
 <keyword name="labels"/>
@@ -106,21 +119,11 @@ not have names)</li>
 </ul>
 <p>
 Creates a layer with the labels from the given layer of the source.
-The layer can be specified by layer and optionally datatype, by a <class_doc href="LayerInfo">LayerInfo</class_doc>
-object or by a sequence of filters. 
-Filters are expressions describing ranges
-of layers and/or datatype numbers or layer names. Multiple filters
-can be given and all layers matching at least one of these filter
-expressions are joined to render the label collection. See "input" for
-more details about the input layer specification.
 </p><p>
-Label layers currently can only be passed to an output layer. 
-Processing of labels is not supported. See "texts" for a way to filter
-texts and use the text locations in geometrical operations.
+This method is identical to <a href="#input">input</a>, but takes only texts from the given input
+layer.
 </p><p>
-<pre>
-labels(1, 0).output(100, 0)
-</pre>
+Use the global version of "label" without a source object to address the default source.
 </p>
 <h2>"layers" - Gets the layers the source contains</h2>
 <keyword name="layers"/>
@@ -152,6 +155,15 @@ layers.each { |l| (input(l) &amp; clip_box).output(l) }
 <ul>
 <li><tt>layout</tt></li>
 </ul>
+<h2>"make_layer" - Creates an empty polygon layer based on the hierarchy of the layout</h2>
+<keyword name="make_layer"/>
+<a name="make_layer"/><p>Usage:</p>
+<ul>
+<li><tt>make_layer</tt></li>
+</ul>
+<p>
+This method delivers a new empty original layer.
+</p>
 <h2>"overlapping" - Specifies input selected from a region in overlapping mode</h2>
 <keyword name="overlapping"/>
 <a name="overlapping"/><p>Usage:</p>
@@ -168,6 +180,24 @@ the specified rectangle.
 <a href="#touching">touching</a> is a similar method which delivers shapes touching
 the search region with their bounding box (without the requirement to overlap)
 </p>
+<h2>"polygons" - Gets the polygon shapes (or shapes that can be converted polygons) from an input layer</h2>
+<keyword name="polygons"/>
+<a name="polygons"/><p>Usage:</p>
+<ul>
+<li><tt>source.polygons(layer)</tt></li>
+<li><tt>source.polygons(layer, datatype)</tt></li>
+<li><tt>source.polygons(layer_into)</tt></li>
+<li><tt>source.polygons(filter, ...)</tt></li>
+</ul>
+<p>
+Creates a layer with the polygon shapes from the given layer of the source.
+With "polygon shapes" we mean all kind of shapes that can be converted to polygons.
+Those are boxes, paths and real polygons.
+</p><p>
+This method is identical to <a href="#input">input</a> with respect to the options supported.
+</p><p>
+Use the global version of "polygons" without a source object to address the default source.
+</p>
 <h2>"select" - Adds cell name expressions to the cell filters</h2>
 <keyword name="select"/>
 <a name="select"/><p>Usage:</p>