Updated contact information. Spelling fixes. Minor updates.

merge-requests/1/head
Henning Geinitz 2003-09-24 14:00:00 +00:00
rodzic 0f6364f640
commit 60ef6c0d21
2 zmienionych plików z 29 dodań i 29 usunięć

Wyświetl plik

@ -1,7 +1,7 @@
2003-02-23 2003-09-24
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-conforming backend and including it into the SANE package:
GETTING STARTED GETTING STARTED
@ -53,7 +53,7 @@ PROGRAMMING
standard. The command "indent -gnu" can be used to reformat standard. The command "indent -gnu" can be used to reformat
existing sources according to this standard. existing sources according to this standard.
* Please be curteous to programmer's with terminals that are 80 * Please be courteous to programmer's with terminals that are 80
characters wide. It's not difficult to avoid long lines, so please characters wide. It's not difficult to avoid long lines, so please
do so. Note that in ANSI C you can split long strings into pieces do so. Note that in ANSI C you can split long strings into pieces
separated by white space. For example, separated by white space. For example,
@ -99,7 +99,7 @@ PROGRAMMING
depends on these libraries or headers, compile the backend only if they are depends on these libraries or headers, compile the backend only if they are
available (see pint for an example). available (see pint for an example).
* Use #include ".../include/sane/..." to inlude the sane header files * Use #include ".../include/sane/..." to include the sane header files
instead of #include <sane/...>. Otherwise problems with different installed instead of #include <sane/...>. Otherwise problems with different installed
SANE versions may occur. Also this makes clear that the local files are used. SANE versions may occur. Also this makes clear that the local files are used.
@ -120,7 +120,7 @@ PROGRAMMING
HTML pages can be generated by calling "doxygen sanei-doxygen.conf" in HTML pages can be generated by calling "doxygen sanei-doxygen.conf" in
the doc/ directory. the doc/ directory.
* Initialize global variables explicitely in sane_init. Keep in mind that * Initialize global variables explicitly in sane_init. Keep in mind that
sane_init can be called more than once (if sane_exit is called everytime sane_init can be called more than once (if sane_exit is called everytime
after sane_init). Therefore don't depend on automatic initialization to after sane_init). Therefore don't depend on automatic initialization to
0 / NULL. 0 / NULL.
@ -136,7 +136,7 @@ PROGRAMMING
* Please do not assume that `size_t' is `unsigned int'. On some * Please do not assume that `size_t' is `unsigned int'. On some
systems, it's `unsigned long' and the size of this type may be systems, it's `unsigned long' and the size of this type may be
bigger than that of an int (this is true for practially any of the bigger than that of an int (this is true for practically any of the
64-bit systems). To print a variable of type size_t portably, cast 64-bit systems). To print a variable of type size_t portably, cast
the variable to u_long and print it with the %lu specifier. E.g.: the variable to u_long and print it with the %lu specifier. E.g.:
@ -146,7 +146,7 @@ PROGRAMMING
* Please do not assume that `void *' has the same size as `int'. On some * Please do not assume that `void *' has the same size as `int'. On some
systems, it's `long' and the size of this type may be bigger than that of systems, it's `long' and the size of this type may be bigger than that of
an int (this is true for practially any of the 64-bit systems). Where this an int (this is true for practically any of the 64-bit systems). Where this
comes up is with opaque handles. For example: comes up is with opaque handles. For example:
int OpaqueHandle; int OpaqueHandle;
@ -166,7 +166,7 @@ PROGRAMMING
* Please try to avoid compilation warnings. At least with "--disable-warnings" * Please try to avoid compilation warnings. At least with "--disable-warnings"
there shouldn't be warnings when compiling backends. It's not necessary to there shouldn't be warnings when compiling backends. It's not necessary to
fix every "unused parameter" warning but take care that no warnings pointing fix every "unused parameter" warning but take care that no warnings pointing
to really existing problems or abiguities are missed. Some programming to really existing problems or ambiguities are missed. Some programming
techniques generating warnings on gcc may lead to errors on other systems. techniques generating warnings on gcc may lead to errors on other systems.
* To support translation of SANE options, please mark the descriptions (desc) * To support translation of SANE options, please mark the descriptions (desc)
@ -223,7 +223,9 @@ DOCUMENTATION
create a .desc file which describes it. Anytime you submit source code for create a .desc file which describes it. Anytime you submit source code for
your backend, you should include an update to the .desc file which reflects your backend, you should include an update to the .desc file which reflects
the new state of the backend. The .desc files are used to create the HTML the new state of the backend. The .desc files are used to create the HTML
lists of supported devices. See http://www.mostang.com/sane/ for the results. lists of supported devices. These lists are updated automatically when you
change a .desc file in CVS. See e.g.
http://www.sane-project.org/lists/sane-mfgs-cvs.html for the results.
* The .desc files are located in the directories "doc/descriptions" and * The .desc files are located in the directories "doc/descriptions" and
"doc/descriptions-external" (for included and external backends). "doc/descriptions-external" (for included and external backends).
@ -262,7 +264,7 @@ CHECKLIST: SUBMITTING A NEW BACKEND
In sane-backends/ In sane-backends/
* Add the author(s) name(s) to AUTHORS * Add the author(s) name(s) to AUTHORS
* Correct any related entries in TODO * Correct any related entries in the bug-tracking system
In sane-backends/backend/ In sane-backends/backend/
* Use the command "indent -gnu" to reformat your code according to the * Use the command "indent -gnu" to reformat your code according to the
@ -286,10 +288,10 @@ INCLUDING INTO CVS
------------------ ------------------
* If you want to include your backend into CVS use the latest CVS to make * If you want to include your backend into CVS use the latest CVS to make
patches. Check the mailing list and the TODO list for information about patches. Check the mailing list and the bug-tracking system for information
bugs to avoid. about bugs to avoid.
* If your backend isn't included yet in the SANE CVS tree, write an email to * If your backend isn't included yet in the SANE CVS tree, write an email to
the SANE mailing list (sane-devel) and ask for inclusion. Usually one the SANE mailing list (sane-devel) and ask for inclusion. Usually one
of the developpers will check the backend for common mistakes and test of the developers will check the backend for common mistakes and test
compilation. If everything is ok the backend will be added to the CVS tree. compilation. If everything is ok the backend will be added to the CVS tree.

Wyświetl plik

@ -1,11 +1,11 @@
2002-09-26 2003-09-24
This text summarizes some points to pay attention to when a new realease This text summarizes some points to pay attention to when a new release
of sane-backends should is planned. of sane-backends should is planned.
Timetable (approximate periods): Timetable (approximate periods):
Day 0: Announcement of upcomming release on sane-devel including timetable Day 0: Announcement of upcoming release on sane-devel including timetable
Day 14: Backend freeze (no new backends are allowed to enter the distribution) Day 14: Backend freeze (no new backends are allowed to enter the distribution)
Day 21: Feature freeze (only bugfixes + documentation updates) Day 21: Feature freeze (only bugfixes + documentation updates)
Day 35: Code freeze (only fixes for bugs that can destroy hardware, can cause Day 35: Code freeze (only fixes for bugs that can destroy hardware, can cause
@ -17,9 +17,9 @@ Before the release:
* Make sure that config.guess and config.sub are up-to-date (get them from * Make sure that config.guess and config.sub are up-to-date (get them from
ftp://ftp.gnu.org/pub/gnu/config/). ftp://ftp.gnu.org/pub/gnu/config/).
* configure.in: increase version number * configure.in: increase version number (twice!)
* configure.in: remove EXTRA version number * configure.in: remove -cvs from textual version number
* configure.in: set --disable-warnings as default * configure.in: set is_release=no
* configure: recreate * configure: recreate
* NEWS: update and enter date of release * NEWS: update and enter date of release
* sane-backends.lsm: update * sane-backends.lsm: update
@ -32,18 +32,16 @@ Before the release:
Making the release: Making the release:
* make tar.gz and sane-backends-x.y.z.lsm with "make sane-backends" * make tar.gz and sane-backends-x.y.z.lsm with "make sane-backends"
* upload both to mostang.com * upload both to the FTP server
* make sane-backends.html (in doc/) and upload to mostang.com * update sane-backends.html and sane-mfgs.html on sane-project.org
* update SANE standard and man pages on mostang.com * update SANE standard and man pages on sane-project.org
(look at `make install-mostang' for both) * check and update platforms page on sane-project.org
* check and update platforms page on mostang.com * write announcements on sane-project.org and sane-devel, maybe others
* write announcements on mostang.com and sane-devel, maybe others
(e.g. freshmeat) (e.g. freshmeat)
* upload to mirrors that don't get the files automatically (sunsite * upload to mirrors that don't get the files automatically (sunsite)
and tsx11)
After the release: After the release:
* configure.in: set --enable-warnings as default * configure.in: add -cvs suffix
* configure.in: add EXTRA version number (usually "-cvs") * configure.in: set is_release=no
* configure: regenerate * configure: regenerate