krb5 commit: Update Build Kerberos V5 doc section
Zhanna A Tsitkova
tsitkova at MIT.EDU
Fri Jun 8 12:38:47 EDT 2012
https://github.com/krb5/krb5/commit/1551355867863f3052ac0a9e1dc5f92608881543
commit 1551355867863f3052ac0a9e1dc5f92608881543
Author: Zhanna Tsitkov <tsitkova at mit.edu>
Date: Fri Jun 8 12:33:49 2012 -0400
Update Build Kerberos V5 doc section
ticket: 7126
doc/rst_source/krb_build/doing_build.rst | 16 ++++++------
doc/rst_source/krb_build/index.rst | 41 +++++++++++++++++------------
2 files changed, 32 insertions(+), 25 deletions(-)
diff --git a/doc/rst_source/krb_build/doing_build.rst b/doc/rst_source/krb_build/doing_build.rst
index d16b73d..7d5f0e5 100644
--- a/doc/rst_source/krb_build/doing_build.rst
+++ b/doc/rst_source/krb_build/doing_build.rst
@@ -21,13 +21,13 @@ rebuild the configure script if it needs rebuilding. If you know that
you have made a change that will require that the configure file be
rebuilt from scratch, specify the **--force** option::
- cd /u1/krb5-1.9/src
+ cd /u1/krb5-VERSION/src
./util/reconf --force
Then follow the instructions for building packaged source trees
(below). To install the binaries into a binary tree, do::
- cd /u1/krb5-1.9/src
+ cd /u1/krb5-VERSION/src
make all
make install DESTDIR=somewhere-else
@@ -49,7 +49,7 @@ systems.
If you don't want separate build trees for each architecture, then use
the following abbreviated procedure::
- cd /u1/krb5-1.9/src
+ cd /u1/krb5-VERSION/src
./configure
make
@@ -69,7 +69,7 @@ directory you might use the following procedure::
mkdir /u1/tmpbuild
cd /u1/tmpbuild
- /u1/krb5-1.9/src/configure
+ /u1/krb5-VERSION/src/configure
make
@@ -82,11 +82,11 @@ not lost. You can use the lndir program to create symbolic link trees
in your build directory.
For example, if you wish to create a build directory for solaris
-binaries you might use the following procedure:
+binaries you might use the following procedure::
- mkdir /u1/krb5-1.9/solaris
- cd /u1/krb5-1.9/solaris
- /u1/krb5-1.9/src/util/lndir `pwd`/../src
+ mkdir /u1/krb5-VERSION/solaris
+ cd /u1/krb5-VERSION/solaris
+ /u1/krb5-VERSION/src/util/lndir `pwd`/../src
./configure
make
diff --git a/doc/rst_source/krb_build/index.rst b/doc/rst_source/krb_build/index.rst
index 7c682f0..b39b242 100644
--- a/doc/rst_source/krb_build/index.rst
+++ b/doc/rst_source/krb_build/index.rst
@@ -3,9 +3,11 @@
Building Kerberos V5
====================
+This section details how to build and install MIT Kerberos software
+from the source.
-Build Requirements
-------------------
+Prerequisites
+-------------
In order to build Kerberos V5, you will need approximately 60-70
megabytes of disk space. The exact amount will vary depending on the
@@ -23,26 +25,31 @@ need a make program which supports **VPATH**, or you will need to use
a tool such as lndir to produce a symbolic link tree for your build
tree.
-The first step in each of these build procedures is to unpack the
-source distribution. The Kerberos V5 distribution comes in a tar
-file, generally named krb5-1.9.tar (for version 1.9. We will assume
-that version is 1.9. Please, adjust this number accordingly), which
-contains a compressed tar file consisting of the sources for all of
-Kerberos (generally krb5-1.9.tar.gz) and a PGP signature for this
-source tree (generally krb5-1.9.tar.gz.asc). MIT highly recommends
-that you verify the integrity of the source code using this signature.
+Obtaining the software
+----------------------
-Unpack the compressed tar file in some directory, such as
-``/u1/krb5-1.9``. (In the rest of this document, we will assume that
-you have chosen to unpack the Kerberos V5 source distribution in this
-directory. Note that the tarfiles will by default all unpack into the
-``./krb5-1.9`` directory, so that if your current directory is ``/u1``
-when you unpack the tarfiles, you will get ``/u1/krb5-1.9/src``, etc.)
+The source code can be obtained from MIT Kerberos Distribution page,
+at http://web.mit.edu/kerberos/dist/index.html.
+The MIT Kerberos distribution comes in an archive file, generally named
+krb5-VERSION.tar, where *VERSION* is a placeholder for the major and minor
+versions of MIT Kerberos. (For example, MIT Kerberos 1.9
+has major version "1" and minor version "9".)
+The krb5-VERSION.tar contains a compressed tar file consisting of the
+sources for all of Kerberos (generally krb5-VERSION.tar.gz) and
+a PGP signature file for this source tree (generally
+krb5-VERSION.tar.gz.asc). MIT highly recommends that you verify
+the integrity of the source code using this signature.
+
+Unpack krb5-VERSION.tar.gz in some directory. In this section we will assume
+that you have chosen the top directory of the distribution the directory
+``/u1/krb5-VERSION``.
+
+Review the README file for the license, copyright and other sprecific to the
+distribution information.
Contents
--------
-
.. toctree::
:maxdepth: 1
More information about the cvs-krb5
mailing list