diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-08 22:31:29 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2009-12-08 22:31:29 +0200 |
commit | aecebd653ebb3751d2680a80bd49bcd1ed00ba62 (patch) | |
tree | a0716830898dc0e76863f6b2271f69288537e57a | |
parent | 67ca2ef061a73bc90e4399471ee0cb3ce6f0ee41 (diff) | |
download | wydawca-aecebd653ebb3751d2680a80bd49bcd1ed00ba62.tar.gz wydawca-aecebd653ebb3751d2680a80bd49bcd1ed00ba62.tar.bz2 |
Minor changes.
* doc/Makefile.am (check-config)
(check-sub-config): New rules.
(all-check-docs): Depend on check-config
and check-sub-config.
* doc/wydawca.texi: Fix configuration statement
markers for use with check-config and check-sub-config
rules.
-rw-r--r-- | doc/Makefile.am | 17 | ||||
-rw-r--r-- | doc/wydawca.texi | 38 |
2 files changed, 34 insertions, 21 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 721ea29..e37b083 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -101,14 +101,27 @@ check-unrevised: check-config: @check-docs.sh 'configuration statements' \ - '/wydawca_keywords\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \ + '/wydawca_kw\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \ 's/@deffnx\{0,1\} {Config} *\([^@,]*\).*/\1/p' \ $(top_srcdir)/src/config.c -- \ $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \ $(info_TEXINFOS) +check-sub-config: + @sed -n '/wydawca_kw\[\] *= *{/,/^}/{p}' ../src/config.c|tr '\n{' ' \n'|sed -n '/grecs_type_section/s/"\([^"]*\)".*grecs_type_section,[^,]*,[^,]*,[^,]*,[^,]*, *\(.*\) *}.*/\1 \2/p' | \ + while read ident kw; do \ + check-docs.sh "$$ident configuration statements" \ + "/$$kw"'\[\] *= *{/,/^}/s/[ \t]*{ *"\([^,"]*\)".*/\1/pg' \ + "s/@deffnx\{0,1\} {Config: *$${ident}}"' *\([^@,]*\).*/\1/p' \ + $(top_srcdir)/src/config.c -- \ + $(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -E - \ + $(info_TEXINFOS); \ + done + -all-check-docs: check-format check-options check-refs check-fixmes check-unrevised check-writeme +all-check-docs: check-format check-options \ + check-config check-sub-config \ + check-refs check-fixmes check-writeme check-unrevised check-docs: $(MAKE) -k all-check-docs diff --git a/doc/wydawca.texi b/doc/wydawca.texi index c5eb691..82b8403 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -771,7 +771,7 @@ syslog @{ @} @end smallexample -@deffn {Configuration} facility @var{name} +@deffn {Config: syslog} facility @var{name} @kwindex authpriv@r{, syslog facility} @kwindex cron@r{, syslog facility} @kwindex daemon@r{, syslog facility} @@ -785,14 +785,14 @@ case-insensitive and may be optionally prefixed with @samp{log_} (case-insensitive as well). @end deffn -@deffn {Configuration} tag @var{string} +@deffn {Config: syslog} tag @var{string} @cindex syslog tag, configuring This statement sets the @dfn{syslog tag}, a string identifying each message issued by the program. By default, the name of the program (@samp{wydawca}) is used. @end deffn -@deffn {Configuration} print-priority @var{bool} +@deffn {Config: syslog} print-priority @var{bool} @cindex syslog priority, printing in diagnostics In addition to priority segregation, provided by @command{syslog}, you can instruct @command{wydawca} to prefix each syslog message with @@ -836,7 +836,7 @@ database. It is used by another configuration statements (e.g. by access methods, see the next section) to refer to this database. -@deffn {Configuration} host @var{hostname}[:@var{port-or-socket}] +@deffn {Config: sql} host @var{hostname}[:@var{port-or-socket}] Set the hostname or @acronym{IP} address of the host running the database. Optional @var{port-or-socket} specifies port number (for @acronym{TCP} connections) or socket name (for @acronym{UNIX} sockets) @@ -845,15 +845,15 @@ omitted. If, however, it is present, it must be @samp{localhost}. @FIXME-xref{sql-host}, for more information and examples. @end deffn -@deffn {Configuration} database @var{name} +@deffn {Config: sql} database @var{name} Specifies the database name. @end deffn -@deffn {Configuration} user @var{name} +@deffn {Config: sql} user @var{name} Sets the database user name. @end deffn -@deffn {Configuration} password @var{string} +@deffn {Config: sql} password @var{string} Sets the password for accessing the database. @end deffn @@ -928,7 +928,7 @@ make uploads. The sub-statements of @code{access-method} are: -@deffn {Configuration} type @var{name} +@deffn {Config: access-method} type @var{name} Defines the type of this method. @var{Name} is one of the following: @table @asis @@ -950,7 +950,7 @@ future use. See below for a detailed description of these access methods. @end deffn -@deffn {Configuration} query @var{string} +@deffn {Config: access-method} query @var{string} Sets the query used for retrieving the data. The @var{string} is subject to meta-variable interpretation (@pxref{meta-interpretation}). The following meta-variables are defined: @@ -992,7 +992,7 @@ Spool source directory (@pxref{spool, source}). @end table @end deffn -@deffn {Configuration} params (@var{param1}, @var{param2}, ...) +@deffn {Config: access-method} params (@var{param1}, @var{param2}, ...) Supplies additional parameters for the method. @end deffn @@ -1152,7 +1152,7 @@ archive @var{type} @{ Store file in a separate directory. @end table -@deffn {Configuration} name @var{file-or-dir} +@deffn {Config: archive} name @var{file-or-dir} Specify the name of the tar archive (if type @samp{tar} is used) or destination directory (if type @samp{directroy} is used). @end deffn @@ -1212,7 +1212,7 @@ directory @file{/home/@/ftp/@/gnu/@/tar/@/.archive}, files from @file{/home/@/ftp/@/gnu/@/tar/@/old} --- in @file{/home/@/ftp/@/gnu/@/tar/@/.archive/@/old}, etc. -@deffn {Configuration} backup @var{type} +@deffn {Config: archive} backup @var{type} @anchor{backup-methods} @vindex version-control @r{Emacs variable} When using the @samp{directory} archivation type, it may happen that the @@ -1303,16 +1303,16 @@ The @var{tag} argument defines a unique identifier for this spool. It will be used in log messages, timers (@FIXME-pxref{timers}) and in meta-variable interpretation (@pxref{meta-interpretation}). -@deffn {Configuration} url @var{string} +@deffn {Config: spool} url @var{string} Defines download @acronym{URL}, associated with this spool. Its value may be used as @samp{$@{url@}} meta-variable in mail notifications. @end deffn -@deffn {Configuration} source @var{dir} +@deffn {Config: spool} source @var{dir} Specifies the location of the source directory. @end deffn -@deffn {Configuration} destination @var{dir} +@deffn {Config: spool} destination @var{dir} Specifies the type and location of the destination directory. The @var{dir} argument must be either an absolute name of a directory on the local file system, or a special @acronym{URL}. @command{Wydawca} @@ -1724,7 +1724,7 @@ mail-statistics @{ @} @end smallexample -@deffn {Configuration} message @var{text-or-id} +@deffn {Config: mail-statistics} message @var{text-or-id} Define the message text. The argument is either the message text template, or a reference to a template previously defined by a @code{define-message} (@pxref{templates}). The reference syntax is: @@ -1737,7 +1737,7 @@ message @@@var{name}; where @var{name} is the message name as used in @code{define-message}. @end deffn -@deffn {Configuration} statistics @var{item-list} +@deffn {Config: mail-statistics} statistics @var{item-list} The argument is a list of statistics keywords as described in @ref{statistics}. A report will be sent only if statistics counters for at least one of the requested categories are not @@ -1834,7 +1834,7 @@ notify-event @{ @} @end smallexample -@deffn {Configuration} event @var{ev-id} +@deffn {Config: notify-event} event @var{ev-id} Send notification when the event @var{ev-id} occurs. The following table describes the available @var{ev-id}s: @@ -1859,7 +1859,7 @@ uploader. @end table @end deffn -@deffn {Configuration} recipient @var{who} +@deffn {Config: notify-event} recipient @var{who} Determines who should receive the notification. The following values for @var{who} are allowed: |