Explained the new status values. Removed reference to emacs-lisp code for generation of HTML

files. Explained unsupported.desc.
merge-requests/1/head
Henning Geinitz 2003-06-18 09:21:32 +00:00
rodzic 39321aa87b
commit ac15bc78b3
2 zmienionych plików z 27 dodań i 15 usunięć

Wyświetl plik

@ -5,6 +5,9 @@
The old backend and device statuses are translated. Removed
the option to generate one big table of backends (wasn't used
anyway).
* doc/descriptions.txt: Explained the new status values. Removed
reference to emacs-lisp code for generation of HTML
files. Explained unsupported.desc.
2003-06-15 Henning Meier-Geinitz <henning@meier-geinitz.de>

Wyświetl plik

@ -9,12 +9,16 @@ included in the SANE distribution are located in
`sane-backends/doc/descriptions/' while descriptions of external backends
should be placed in `sane-backends/doc/descriptions-external/'.
There is a special file `sane-backends/doc/descriptions/unsupported.desc' that
doesn't belong to a backend but lists all (known) devices not supported by
SANE. It may contain additional information about the device or links to
non-SANE based programs.
The specification files can be used to generate lists of backends and/or
supported devices, databases and similar sources of information. Currently
the creation of two HTML lists is supported by `tools/sane-desc.el' and
`tools/sane-desc-external.el'. The generation of the HTML pages can be
started by `make sane-backends.html' and `make sane-backends-external.html' in
the doc/ directory.
the creation of HTML lists is supported by `tools/sane-desc.c'. The
generation of the HTML pages can be started by `make html-pages' in the doc/
directory.
The file contents is basically emacs-lisp --- so ";" indicates comment to end
of line. Empty lines are ignored.
@ -35,12 +39,8 @@ they shouldn't be used more than once per file.
`:version' has one string argument containing the backend's version
number. The version should match the version used in the backend source code.
Example: `:version: "12.3.5"'
The keyword `:status' is an indication of the stability of the backend. It's
followed by one of the following keyword arguments: `:alpha', `:beta', or
`:stable'.
Example: `:status :stable'
Example: `:version: "12.3.5"'. If the backend isn't maintained, the version
should be `UNMAINTAINED' or contain this tag together with the version number.
`:new' indicates that the backend is brand-new in the latest SANE release if
the keyword argument is `:yes'. Otherwise, `:no' should be used or `:new'
@ -83,11 +83,20 @@ previous `:model', is optional and should be used only once per model.
Example: `:interface "SCSI USB IEEE-1394"'
The keyword `:status' is an indication of the level of support for the model.
It's followed by one of the following keyword arguments: `:alpha', `:beta',
`:stable', `:untested', or `:unsupported'. The `:status' keyword refers to the
previous `:model', is optional and should be used only once per model. If it's
not used, the backend's status (if set) is valid for all models.
Example: `:status :untested'
It's followed by one of the following keyword arguments: `:unsupported',
`:untested', `:minimal', `:basic', `:good', or `:complete'. The `:status'
keyword refers to the previous `:model', is optional and should be used only
once per model.
`:unsupported' means the device is not supported at least by this backend. The
keyword should only be used in the file `unsupported.desc', or to make clear
that a specific scanner is not supported by a backend. `:untested' means the
device may be supported but couldn't be tested. `:minimal' means that the
device is detected and scans at least in one mode. But the quality is bad or
important features won't work. `:basic' means it works at least in the most
important modes but quality is not perfect. `:good' means the device is usable
for day-to-day work. Some rather exotic features may be missing. `:complete'
means the backends supports everything the device can do. Example: `:status
:untested'
The `:desc' keyword token is used for non-hardware devices (API and meta). Its
string argument describes the meta backend or API. It should be used only once