afs: Log pid with disk cache read errors

[openafs.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index d2b4cf6..f9b3166 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -30,7 +30,6 @@ A  Configuring
       A directory will be automatically created for binaries to be written
       into with this name when you build.
 
-      alpha_dux40, alpha_dux50, alpha_dux51 (client does not work)
       alpha_linux26
       alpha_nbsd15, alpha_nbsd16
       amd64_fbsd_80, amd64_fbsd_81, amd64_fbsd_82, amd64_fbsd_83,
@@ -38,7 +37,7 @@ A  Configuring
          amd64_fbsd_93, amd64_fbsd_100, amd64_fbsd_101
       amd64_linux26
       amd64_nbsd20, amd64_nbsd30, amd64_nbsd40
-      arm_linux26
+      arm_linux26, arm64_linux26
       hp_ux11i, hp_ux110, hp_ux1123 (See notes below for information on
          getting missing header)
       hp_ux102 (Client port possible, but db servers and utilities work)
@@ -203,9 +202,7 @@ D  Linux Notes
    last kernel you built for, the previous kernel module will be
    overwritten.
 
-   The Linux 2.4 series (and older) are no longer supported. The OpenAFS 1.6
-   series of releases are the last ones supporting those old kernels and in
-   particular their LinuxThreads.
+   The minimum supported Linux kernel is 2.6.18.
 
 E  HP-UX 11.0 Notes
 
@@ -218,7 +215,8 @@ E  HP-UX 11.0 Notes
 F  OpenBSD Notes
 
    If you need to run regen.sh to make the configure script, you should
-   first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
+   set the environment variable AUTOCONF_VERSION to the installed autoconf
+   version, e.g. 'setenv AUTOCONF_VERSION 2.64' (see 'J' below).
 
    You need kernel source installed to build OpenAFS.  Use the
    --with-bsd-kernel-headers= configure option if your kernel source is
@@ -236,11 +234,10 @@ F  OpenBSD Notes
 
 G  FreeBSD Notes
 
-   The FreeBSD client supports FreeBSD 8.x and later, but does not receive
-   regular testing on versions older than FreeBSD 9.x at this time.  Only
-   the amd64 and i386 architectures are supported, but it should not be
-   hard to port to other processors if they are already supported under
-   another operating system.
+   The FreeBSD client supports FreeBSD 10.x and later.  Only the amd64
+   and i386 architectures are supported, but it should not be hard to
+   port to other processors if they are already supported under another
+   operating system.
 
    You need kernel source installed to build OpenAFS.  Use the
    --with-bsd-kernel-headers= configure option if your kernel source is
@@ -499,6 +496,13 @@ I  Other configure options
        xsltproc.  By default, the user's path is searched for those
        programs in that order, and the first one found is used.
 
+   --with-ctf-tools[=DIR]
+       Location of ctfconvert and ctfmerge. Defaults to detect. These
+       tools create a reduced form of debug information that describes
+       types and function prototypes. This option is only relevant to
+       platforms that provide CTF tools and, at the moment, it is only
+       functional on Solaris (onbld package must be installed).
+
    There are also some environment variables that you can set to control
    aspects of the build.  They can be set either on the configure command
    line (preferred) or in the environment.
@@ -506,7 +510,9 @@ I  Other configure options
    CC
        The C compiler to use.  Be aware that this is overridden on some
        architectures that require a specific compiler be used to build the
-       kernel module.
+       kernel module.  If gcc is used, version 3 or later is required.
+       If clang is used, version 3 or later is required.  (Additional
+       restrictions apply when --enable-checking is used.)
 
    CFLAGS
        Additional flags to pass to the C compiler.
@@ -554,3 +560,22 @@ I  Other configure options
 
    YFLAGS
        Additional flags to pass to yacc.
+
+J  Creating 'configure'
+
+   Normally you can use the configure script provided with the OpenAFS release
+   tar file, but if you are patching the autoconf logic or building directly
+   from source pulled from the git repository you may need to (re-)generate
+   the configure script.
+
+   To create the configure script autoconf-2.64 or later and libtool-1.9b or
+   later are needed.
+
+   Running the script 'regen.sh' creates the configure script.  In addition
+   to creating the configure script, regen.sh will also, by default, build
+   the man pages, which requires the pod2man utility. Use 'regen.sh -q' to
+   skip building the man pages.
+
+   It is possible to create the configure script on one system to be used on
+   another. Ensure that the files created by 'regen.sh' are copied to the
+   target system.
\ No newline at end of file