xorn/tests/netlist/README

   1 Tests for xorn-netlist
   2 ======================
   3
   4 These are the original tests used by gnetlist which compare the
   5 netlister output for a set of test schematics with known good output
   6 files.  To run the tests, type:
   7
   8     make check
   9
  10 Since xorn-netlist produces slightly different output than the old
  11 gnetlist binary, the reference output files have been modified to
  12 accomodate these differences.
  13
  14 - The original order in which the pins on a net used to be listed in
  15   gnetlist is hard to predict and depends on the internal connectivity
  16   checking algorithm.  Since it's *almost* the order of the pins in
  17   the file, they are now sorted in that order.
  18
  19 - The VAMS backend included all attributes on the first component of a
  20   package in the output except "refdes", "source", and "architecture".
  21   For slotted packages, this means a semi-arbitrary value for "slot"
  22   was used.  The new attribute code considers all components of a
  23   package and raises an error if there are inconsistent values.
  24   Therefore, the "slot" attribute is now excluded, too.
  25
  26 - gnetlist:vams-get-package-attributes returned the names of all
  27   attributes attached to a package's first component, including those
  28   which have been set to "unknown".  This has been fixed; now only
  29   attributes whose value is not "unknown" are listed in the output.
  30
  31 - If an artificial pin was present in multiple components of a
  32   package, get-pins and get-pins-nets returned the pin once for each
  33   component, resulting in duplicate pins in the output.  This has been
  34   fixed; each pin in now listed only once.
  35
  36 - The renamed-nets section in the test backend has been removed as it
  37   isn't meaningful any longer.
  38
  39 - With the new subsheet link-up code, the order of the pins on an
  40   inter-schematic net connected to multiple ports now depends
  41   primarily on the order of the pins of the subsheet symbol instead of
  42   the order of the pins inside the subsheet.
  43
  44 - Some of the errors covered in the DRC2 tests are now detected by the
  45   netlister and cause it to abort with an error, so netlist errors are
  46   ignored for this backend.
  47
  48 The tests do NOT cover most of the more advanced features of the
  49 backends; they are basically just a bunch of standard schematics run
  50 through each backend, whether meaningful or not.
  51
  52 Please note that the tests only make sure there are no accidental new
  53 defects.  In particular, it has not been checked whether the original
  54 output files were correct in the first place.
  55
  56 --------------------------------------------------------------------------------
  57
  58 Copyright (C) 2013-2020 Roland Lutz
  59
  60 Permission is granted to copy, distribute and/or modify this document
  61 under the terms of the GNU Free Documentation License, Version 1.2 or
  62 any later version published by the Free Software Foundation; with no
  63 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  64 Texts.  A copy of the license is included in the ``GNU Free
  65 Documentation License'' file as part of this distribution.