Command line switch documentation


To ng-spice-devel <ng-spice-devel@ieee.ing.uniroma1.it>
From "Arno W. Peters" <a.w.peters@ieee.org>
Date Sat, 17 Jun 2000 00:11:14 +0200
Delivered-To mailing list ng-spice-devel@ieee.ing.uniroma1.it
Mailing-List contact ng-spice-devel-help@ieee.ing.uniroma1.it; run by ezmlm
Reply-To ng-spice-devel@ieee.ing.uniroma1.it
User-Agent Mutt/1.2i


Documentation for the command line switches for nutmeg and spice can
be found in three places:

  src/ngspice.c and src/nutmeg.c
  doc/ngspice.texi
  man/man1/ngspice.1 and man/man1/nutmeg.1

Of these three, the source code files are the most accurate.  The
other documents are out of sync with respect to command line
switches.

I would like to see the documentation for the switches be generated
from the --help output and dynamically put into the other
documentation.  On freshmeat, I saw a tool help2doc that does this
conversion.

In a more general fashion, I would like to distribute the
documentation.

  Documentation for a device in the directory for that device.
  Documentation of analysis in the analysis directory.
  Include License information from COPYING file
  Include Authors information from AUTHORS file
  Automatically generate DEVICES and ANALYSIS files on top level
  Automatically generate manual page from help output
  Automatically document ngspice API (once available) from source files.

Advantages:

  This approach makes updating the documentation easier because you
  the device document is small and the document is nearby.

  It avoid duplication of documentation.  Docs can't get out of sync.


I welcome patches that implement one or more of the goals stated
above.

Regards,
-- 
Arno

PGP signature


Partial thread listing: