From e7100e275d58d67b903e883e7a02e45d18f81ef7 Mon Sep 17 00:00:00 2001 From: Olaf Meeuwissen Date: Wed, 15 Jun 2016 20:47:28 +0900 Subject: [PATCH] Update documentation to reflect recent changes --- README | 5 +++-- doc/backend-writing.txt | 22 ++++++++++------------ doc/releases.txt | 14 ++++---------- 3 files changed, 17 insertions(+), 24 deletions(-) diff --git a/README b/README index 5841f3bd2..4a9d31a77 100644 --- a/README +++ b/README @@ -36,8 +36,9 @@ In order to build SANE, the following tools and libraries are required: - GNU make: version 3.70 or newer - - ANSI C compiler: GNU C (gcc) is recommended for best performance, - but any ANSI-compliant compiler should do + - ISO C99 compiler: GNU C (gcc) is recommended for best results, + but any ISO C99 compliant compiler should do + Some more libraries are not strictly necessary to compile SANE, but some functionality may be lost if they are not available. Make sure that these diff --git a/doc/backend-writing.txt b/doc/backend-writing.txt index 7d2fc415e..7e34d6a19 100644 --- a/doc/backend-writing.txt +++ b/doc/backend-writing.txt @@ -43,8 +43,8 @@ CONFIGURATION AND BUILD SYSTEM ------------------------------ Sane-backends uses the autoconf and automake tools. The configure script is -generated from configure.in and aclocal.m4 by running "autoreconf". -Simple checks (e.g. for headers) should be placed into configure.in while +generated from configure.ac and aclocal.m4 by running "autoreconf". +Simple checks (e.g. for headers) should be placed into configure.ac while for more complex stuff acinclude.m4 is the right file. After changes in one of these files, "autoreconf" should be called. This will then call a chain of autotools, such as autoconf to generate configure, autoheader @@ -77,7 +77,7 @@ sane-backends distribution. sane-backends/ * acinclude.m4 aclocal.m4 compile config.guess config.sub configure - configure.in depcomp install-sh ltmain.sh Makefile.am Makefile.in missing + configure.ac depcomp install-sh ltmain.sh Makefile.am Makefile.in missing mkinstalldirs: Part of the build system as explained above. * ChangeLog: The ChangeLog contains all the changes made since the last stable release. @@ -154,7 +154,7 @@ sane-backends/doc/ Contains additional information about newbackend, e.g. READMEs or TODO files. General files: - * Makefile.in: + * Makefile.am: "sane-newbackend.5" must be added to variable BACKEND_5MANS and "sane-newbackend.man" to EXTRA_DIST. A backend documentation directory (if used) must be added to the BEDOCS variable. @@ -229,7 +229,7 @@ PROGRAMMING * To add the backend to the existing SANE code, the following must be done at least: - - add the backend name to ALL_BACKENDS in configure.in (and run autoreconf) + - add the backend name to ALL_BACKENDS in configure.ac (and run autoreconf) - Add new backend to BACKEND_CONFS, be_convenience_libs, be_dlopen_libs, and define _lib${backend}_la_SOURCES and nodist_libsane_${backend}_la_SOURCES; using an existing backend as @@ -255,20 +255,18 @@ PROGRAMMING * Please be courteous to programmer's with terminals that are 80 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 standard C you can split long strings into pieces separated by white space. For example, "this is an awfully long string" can be written as "this is an " "awfully long string". -* Use only ANSI C for your backend. C99 is not supported by the compilers of - some older platforms so please avoid using its features. +* Use only standard C for your backend. ISO C99 support will be enabled + if supported by the compiler detected by configure. * Please do not depend on compiler specific features or, if you do, make the dependency conditional so other compilers will still be able to compile the files. In particular: - - do not use C++ style comments (//-line comments) - - do not declare dynamically sized automatic arrays; instead, use alloca() after including "../include/lalloca.h". For example: @@ -296,7 +294,7 @@ PROGRAMMING compiler-dependent. * If you use headers or libraries that may not be available on all systems, - write a check for configure.in and include it conditionally. If your backend + write a check for configure.ac and include it conditionally. If your backend depends on these libraries or headers, compile the backend only if they are available (see pint for an example). @@ -477,7 +475,7 @@ In sane-backends/backend/ In sane-backends/doc/ * Add an entry for the man page in sane.man -* Add the man page file in doc/Makefile.in +* Add the man page file in doc/Makefile.am * Move the description file from descriptions-external/ to doc/descriptions/ * Check that the description file is correct: "cd doc; make html-pages" and check the html pages result with a browser. diff --git a/doc/releases.txt b/doc/releases.txt index ca520a6c8..9f5baf95e 100644 --- a/doc/releases.txt +++ b/doc/releases.txt @@ -17,13 +17,9 @@ Before the release: * set :new :yes on any new backend .desc files * Make sure that config.guess and config.sub are up-to-date (get them from savannah.gnu.org/projects/config) -* configure.in: increase version number -* configure.in: remove 'git' from textual version number -* configure.in: set is_release=yes -* OPTIONAL: aclocal.m4: recreate by running aclocal -* OPTIONAL: include/sane/config.h.in: recreate (autoheader in root of checkout) -* DONT run autoreconf, it will overwrite our custom ltmain.sh -* configure: recreate by running autoconf +* configure.ac: remove 'git' from textual version number +* run autoreconf --force but do *NOT* use the --install option as it will + overwrite our custom ltmain.sh * NEWS: update and enter date of release * sane-backends.lsm: update * ChangeLog: generate from git log @@ -79,9 +75,7 @@ After the release: * move ChangeLog to ChangeLog-"version" * start a new ChangeLog * add ChangeLog-"version" to EXTRA_DIST in Makefile.in and Makefile.am -* configure.in: bump textual version & add 'git' suffix -* configure.in: bump V_REV -* configure.in: set is_release=no +* configure.ac: bump textual version & add 'git' suffix * configure: regenerate with autoconf * remove the ':new' tag from any new backends .desc files * git add new files and commit