summaryrefslogtreecommitdiff
path: root/doc/modules
diff options
context:
space:
mode:
authorLudovic Courtès2008-01-24 16:02:43 +0100
committerLudovic Courtès2008-01-24 16:02:43 +0100
commit87819ed728dc9cbb2cccbf236a665709ef663abf (patch)
tree1dc6713bc640423ae52f50bdbb1da0ed08812900 /doc/modules
parentbf65015355fc0afe9bde6edc85118818de27bedc (diff)
downloadskribilo-87819ed728dc9cbb2cccbf236a665709ef663abf.tar.gz
skribilo-87819ed728dc9cbb2cccbf236a665709ef663abf.tar.lz
skribilo-87819ed728dc9cbb2cccbf236a665709ef663abf.zip
doc: Document the "compiler".
* doc/modules/skribilo/documentation/manual.scm (compiler-options): Rewritten to suit our needs. * doc/user/Makefile.am (EXTRA_DIST): `skribec.skb' renamed to `compiler.skb'. * doc/user/bib.skb: Fix xref. * doc/user/lib.skb: Likewise. * doc/user/links.skb: Likewise. * doc/user/syntax.skb: Add `:ident'.
Diffstat (limited to 'doc/modules')
-rw-r--r--doc/modules/skribilo/documentation/manual.scm61
1 files changed, 52 insertions, 9 deletions
diff --git a/doc/modules/skribilo/documentation/manual.scm b/doc/modules/skribilo/documentation/manual.scm
index 4010982..9fddcaf 100644
--- a/doc/modules/skribilo/documentation/manual.scm
+++ b/doc/modules/skribilo/documentation/manual.scm
@@ -36,7 +36,10 @@
:use-module (skribilo source xml)
:use-module (oop goops)
- :use-module (ice-9 optargs))
+ :use-module (ice-9 optargs)
+ :use-module (srfi srfi-1)
+ :use-module (srfi srfi-13)
+ :use-module (srfi srfi-37))
(fluid-set! current-reader %skribilo-module-reader)
@@ -401,11 +404,51 @@
;*---------------------------------------------------------------------*/
;* compiler-options ... */
;*---------------------------------------------------------------------*/
-(define-markup (compiler-options bin)
- (skribe-message " [executing: ~a --options]\n" bin)
- (let ((port (open-input-file (format #f "| ~a --options" bin))))
- (let ((opts (read port)))
- (close-input-port port)
- (apply description (map (lambda (opt) (item :key (bold (car opt))
- (cadr opt) "."))
- opts)))))
+(define-markup (compiler-options module . descriptions)
+ ;; Fetch an SRFI-37 option list from MODULE (a module name) and use option
+ ;; descriptions from DESCRIPTIONS.
+
+ ;; XXX: We don't have something as smart as what Skribe had that would
+ ;; allow automatic extract of option documentation. OTOH, descriptions in
+ ;; the manual can be verbose and can include hyperlinks, which differs from
+ ;; descriptions in `--help' output, so it makes sense to have some
+ ;; duplication here.
+ (let ((options (module-ref (resolve-module module) '%options)))
+ (description
+ (map (lambda (option)
+ (let* ((names (option-names option))
+ (short-name (find char? names))
+ (long-names (filter string? names))
+ (doc (assoc-ref descriptions
+ (or short-name (car long-names)))))
+ (define (make-option-list)
+ (let ((long (map (lambda (long)
+ (string-append "--" long))
+ long-names)))
+ (string-join (if short-name
+ (cons (string-append "-"
+ (string short-name))
+ long)
+ long)
+ ", ")))
+
+ (define (make-key)
+ (string-append
+ (make-option-list)
+ (let ((arg-name (if doc (car doc) "ARG")))
+ (cond ((option-required-arg? option)
+ (string-append (if (null? long-names) " " "=")
+ arg-name))
+ ((option-optional-arg? option)
+ (string-append (if (null? long-names) " [" "[=")
+ arg-name "]"))
+ (else "")))))
+
+ (item :key (tt (make-key))
+ (if doc
+ (if (or (option-optional-arg? option)
+ (option-required-arg? option))
+ (cadr doc)
+ (car doc))
+ ""))))
+ options))))