Node:Doc Snarfing, Previous:Init Snarfing with guile-snarf, Up:Snarfing

13.1.2 Doc Snarfing

In addition to init snarfing (see Init Snarfing with guile-snarf), the libguile sources are also subject to doc snarfing, by programs that are included in the distribution (but not installed at this time). The output is the file guile-procedures.txt which is installed, and subsequently used by module (ice-9 documentation).

Here is a list of what does what according to libguile/Makefile.am:

• guile-snarf-docs runs cpp defining SCM_MAGIC_SNARF_DOCS
• guile_filter_doc_snarfage parses guile-snarf-docs output to produce .doc
• ../scripts/snarf-check-and-output-texi makes guile.texi
• ../scripts/snarf-check-and-output-texi makes guile-procedures.txt
• guile-func-name-check checks source snarf-syntax integrity (optional?)
• guile-doc-snarf calls guile-snarf-docs (to make .doc) and guile-snarf

Note that for guile-1.4, a completely different approach was used! All this is rather byzantine, so for now NO doc snarfing programs are installed.

[fixme: Document further once doc snarfing is tamed somewhat. -ttn]