mirror
/
sane-project-backends
kopia lustrzana https://gitlab.com/sane-project/backends
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Updated concerning splitted .desc directories. 

Henning Meier-Geinitz <henning@meier-geinitz.de>
DEVEL_2_0_BRANCH-1
Henning Geinitz 2002-03-21 18:43:47 +00:00
rodzic 60b4f5e91c
commit 02cf8e08fe
1 zmienionych plików z 25 dodań i 20 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

45
doc/backend-writing.txt
Wyświetl plik

@ -1,4 +1,4 @@
2002-01-24 2002-03-21
Here are a few rules and tips that should help writing a Here are a few rules and tips that should help writing a
SANE-conformant backend and including it into the SANE package: SANE-conformant backend and including it into the SANE package:
@ -184,30 +184,35 @@ TESTING
DOCUMENTATION DOCUMENTATION
------------- -------------
* Even if you haven't written a man-page for your backend yet, you * Even if you haven't written a man-page for your backend yet, you *must*
*must* create a .desc file which describes it. Anytime you submit create a .desc file which describes it. Anytime you submit source code for
source code for your backend, you should include an update to the your backend, you should include an update to the .desc file which reflects
.desc file which reflects the new state of the backend. the new state of the backend. The .desc files are used to create the HTML
lists of supported devices.
* "template.desc." is a template for new .desc files. If you'd like * The .desc files are located in the directories "doc/descriptions" and
to try parsing your creation to recreate the sane-backends webpage, "doc/external/descriptions" (for included and external backends).
look at "sane-desc.el" in the tools/ directory or use
"make sane-backends.html" in doc/. It may be necessary to adjust the
Makefile.
* When your backend is included in the SANE distribution, add an entry * "template.desc." is a template for new .desc files. The format of the files
to doc/sane.man, AUTHORS and sane-backends.lsm. The sane.man entry should in the two directories is very similar. If you'd like to try parsing your
point to your documentation (man-page, website, readme). creation to recreate the sane-backends webpages, look at "sane-desc.el" and
"sane-desc-ext.el" in the tools/ directory or use "make sane-backends.html"
and "make sane-backends-external.html" in "doc/". It may be necessary to
adjust the Makefile.
* When your backend is included in the SANE distribution, add an entry to
doc/sane.man, AUTHORS and sane-backends.lsm. The sane.man entry should point
to your documentation (man-page, website, readme). Also move your .desc
file from "doc/external-descriptions" to "doc/descriptions".
* In your manual page (backend.man), use @LIBDIR@ and the other macros for * In your manual page (backend.man), use @LIBDIR@ and the other macros for
path names to the libraries, config files and documentation. Don't use path names to the libraries, config files and documentation. Don't use fixed
fixed paths as they will be wrong if SANE is installed with a different paths as they will be wrong if SANE is installed with a different prefix
prefix (e.g. /usr instead of /usr/local). (e.g. /usr instead of /usr/local).
* If you want to include READMEs, HTML files or other documentation, * If you want to include READMEs, HTML files or other documentation, please
please create your own directory (doc/backendname) and store your files create your own directory (doc/backendname) and store your files in this
in this directory. If you only have a manual page a subdirectory isn't directory. If you only have a manual page a subdirectory isn't necessary.
necessary.
* Please keep your manpages and .desc files up-to-date especially regarding * Please keep your manpages and .desc files up-to-date especially regarding
version numbers. version numbers.