From 7a7ee20bb609ec0b23d36d2376ffc6eda58fa47b Mon Sep 17 00:00:00 2001 From: Garrett Wollman Date: Thu, 13 Feb 2014 23:03:59 -0500 Subject: [PATCH] doc: Document dependencies required for building everything Add a new section to README.DEVEL that describes the packages required to build everything (including all optional code like the FUSE-based user-mode client). Start with what I figured out for FreeBSD (tested on a clean 10.0 install) and what Russ Allbery described on the openafs-devel list in . Change-Id: Ib90cd653a822f8699df613aabdd3442edc10c98a Reviewed-on: http://gerrit.openafs.org/10844 Reviewed-by: Ken Dreyer Reviewed-by: Jeffrey Altman Tested-by: Jeffrey Altman --- README.DEVEL | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.DEVEL b/README.DEVEL index b7b57a8c95..7ad8170789 100644 --- a/README.DEVEL +++ b/README.DEVEL @@ -82,3 +82,24 @@ Suggested compiler flags: Solaris Workshop CC: -fd -v (You might not want the -fd, it isn't really useful, just complains about the K&R style functions, but -v gives useful info.) + + +Dependencies required to build OpenAFS from source +-------------------------------------------------- +The following packages are required to build all of the OpenAFS code +from source on various operating systems: + +On Debian: +- autoconf, automake, bison, comerr-dev, cpio, flex, libkrb5-dev, + libncurses5-dev, libpam0g-dev, libxml2-utils, perl, pkg-config; +- libfuse-dev (for the FUSE-based user-mode client); +- dblatex, docbook-xsl, doxygen, xsltproc (for documentation); +- debhelper, hardening-wrapper, dkms (to build the Debian packages) + +On FreeBSD: +- autoconf, automake, libtool; +- fusefs-libs, pkgconf (for the FUSE-based user-mode client); +- perl, dblatex, docbook-xsl, libxslt, python, ruby, zip (for documentation) + +In addition, FreeBSD systems require kernel sources and a configured kernel +build directory (see section "FreeBSD Notes" in the README file).