diff options
| author | Cy Schubert <cy@FreeBSD.org> | 2025-03-19 22:12:25 +0000 |
|---|---|---|
| committer | Cy Schubert <cy@FreeBSD.org> | 2025-03-19 22:12:25 +0000 |
| commit | 8f7d3ef26dec89a92ec0665de84a5936310a5574 (patch) | |
| tree | 9a465418bd4056bf0d369751320a414eaed29fa4 /doc/html/build/doing_build.html | |
| parent | 1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff) | |
Diffstat (limited to 'doc/html/build/doing_build.html')
| -rw-r--r-- | doc/html/build/doing_build.html | 114 |
1 files changed, 54 insertions, 60 deletions
diff --git a/doc/html/build/doing_build.html b/doc/html/build/doing_build.html index 16dfc24f3734..4b5b1b643b3d 100644 --- a/doc/html/build/doing_build.html +++ b/doc/html/build/doing_build.html @@ -1,35 +1,26 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml"> +<html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + <title>Doing the build — MIT Kerberos Documentation</title> - <link rel="stylesheet" href="../_static/agogo.css" type="text/css" /> - <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> - <link rel="stylesheet" href="../_static/kerb.css" type="text/css" /> - <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT: '../', - VERSION: '1.21.2', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' - }; - </script> - <script type="text/javascript" src="../_static/jquery.js"></script> - <script type="text/javascript" src="../_static/underscore.js"></script> - <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../_static/agogo.css" /> + <link rel="stylesheet" type="text/css" href="../_static/kerb.css" /> + <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> + <script src="../_static/jquery.js"></script> + <script src="../_static/underscore.js"></script> + <script src="../_static/doctools.js"></script> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="Options to configure" href="options2configure.html" /> <link rel="prev" title="Organization of the source directory" href="directory_org.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,9 +52,9 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="doing-the-build"> + <section id="doing-the-build"> <h1>Doing the build<a class="headerlink" href="#doing-the-build" title="Permalink to this headline">¶</a></h1> -<div class="section" id="building-within-a-single-tree"> +<section id="building-within-a-single-tree"> <span id="do-build"></span><h2>Building within a single tree<a class="headerlink" href="#building-within-a-single-tree" title="Permalink to this headline">¶</a></h2> <p>If you only need to build Kerberos for one platform, using a single directory tree which contains both the source files and the object @@ -74,30 +65,30 @@ Incompatibilities, for notes that we have on particular operating systems.</p> <p>If you don’t want separate build trees for each architecture, then use the following abbreviated procedure:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">krb5</span><span class="o">-</span><span class="n">VERSION</span><span class="o">/</span><span class="n">src</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">krb5</span><span class="o">-</span><span class="n">VERSION</span><span class="o">/</span><span class="n">src</span> <span class="o">./</span><span class="n">configure</span> <span class="n">make</span> </pre></div> </div> <p>That’s it!</p> -</div> -<div class="section" id="building-with-separate-build-directories"> +</section> +<section id="building-with-separate-build-directories"> <h2>Building with separate build directories<a class="headerlink" href="#building-with-separate-build-directories" title="Permalink to this headline">¶</a></h2> <p>If you wish to keep separate build directories for each platform, you can do so using the following procedure. (Note, this requires that your make program support VPATH. GNU’s make will provide this functionality, for example.) If your make program does not support this, see the next section.</p> -<p>For example, if you wish to store the binaries in <code class="docutils literal"><span class="pre">tmpbuild</span></code> build +<p>For example, if you wish to store the binaries in <code class="docutils literal notranslate"><span class="pre">tmpbuild</span></code> build directory you might use the following procedure:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">tmpbuild</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">tmpbuild</span> <span class="n">cd</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">tmpbuild</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">krb5</span><span class="o">-</span><span class="n">VERSION</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">configure</span> <span class="n">make</span> </pre></div> </div> -</div> -<div class="section" id="building-using-lndir"> +</section> +<section id="building-using-lndir"> <h2>Building using lndir<a class="headerlink" href="#building-using-lndir" title="Permalink to this headline">¶</a></h2> <p>If you wish to keep separate build directories for each platform, and you do not have access to a make program which supports VPATH, all is @@ -105,7 +96,7 @@ not lost. You can use the lndir program to create symbolic link trees in your build directory.</p> <p>For example, if you wish to create a build directory for solaris binaries you might use the following procedure:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>mkdir /u1/krb5-VERSION/solaris +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>mkdir /u1/krb5-VERSION/solaris cd /u1/krb5-VERSION/solaris /u1/krb5-VERSION/src/util/lndir `pwd`/../src ./configure @@ -116,19 +107,19 @@ make makes it fail for relative pathnames. Note that this version differs from the latest version as distributed and installed by the XConsortium with X11R6. Either version should be acceptable.</p> -</div> -<div class="section" id="installing-the-binaries"> +</section> +<section id="installing-the-binaries"> <h2>Installing the binaries<a class="headerlink" href="#installing-the-binaries" title="Permalink to this headline">¶</a></h2> <p>Once you have built Kerberos, you should install the binaries. You can do this by running:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">install</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">install</span> </pre></div> </div> <p>If you want to install the binaries into a destination directory that is not their final destination, which may be convenient if you want to build a binary distribution to be deployed on multiple hosts, you may use:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">install</span> <span class="n">DESTDIR</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">destdir</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">install</span> <span class="n">DESTDIR</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">destdir</span> </pre></div> </div> <p>This will install the binaries under <em>DESTDIR/PREFIX</em>, e.g., the user @@ -138,18 +129,18 @@ programs will install into <em>DESTDIR/PREFIX/bin</em>, the libraries into parallel, for faster builds. We test our Makefiles in parallel builds with GNU make only; they may not be compatible with other parallel build implementations.</p> -</div> -<div class="section" id="testing-the-build"> +</section> +<section id="testing-the-build"> <h2>Testing the build<a class="headerlink" href="#testing-the-build" title="Permalink to this headline">¶</a></h2> <p>The Kerberos V5 distribution comes with built-in regression tests. To run them, simply type the following command while in the top-level build directory (i.e., the directory where you sent typed make to start building Kerberos; see <a class="reference internal" href="#do-build"><span class="std std-ref">Building within a single tree</span></a>):</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">check</span> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">check</span> </pre></div> </div> -<p>On some operating systems, you have to run <code class="docutils literal"><span class="pre">make</span> <span class="pre">install</span></code> before -running <code class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></code>, or the test suite will pick up installed +<p>On some operating systems, you have to run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> before +running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">check</span></code>, or the test suite will pick up installed versions of Kerberos libraries rather than the newly built ones. You can install into a prefix that isn’t in the system library search path, though. Alternatively, you can configure with @@ -157,49 +148,51 @@ path, though. Alternatively, you can configure with for installation, but allows testing without interference from previously installed libraries.</p> <p>There are additional regression tests available, which are not run -by <code class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></code>. These tests require manual setup and teardown of +by <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">check</span></code>. These tests require manual setup and teardown of support infrastructure which is not easily automated, or require excessive resources for ordinary use. The procedure for running the manual tests is documented at <a class="reference external" href="https://k5wiki.kerberos.org/wiki/Manual_Testing">https://k5wiki.kerberos.org/wiki/Manual_Testing</a>.</p> -</div> -<div class="section" id="cleaning-up-the-build"> +</section> +<section id="cleaning-up-the-build"> <h2>Cleaning up the build<a class="headerlink" href="#cleaning-up-the-build" title="Permalink to this headline">¶</a></h2> <ul class="simple"> -<li>Use <code class="docutils literal"><span class="pre">make</span> <span class="pre">clean</span></code> to remove all files generated by running make -command.</li> -<li>Use <code class="docutils literal"><span class="pre">make</span> <span class="pre">distclean</span></code> to remove all files generated by running -./configure script. After running <code class="docutils literal"><span class="pre">make</span> <span class="pre">distclean</span></code> your source +<li><p>Use <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code> to remove all files generated by running make +command.</p></li> +<li><p>Use <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">distclean</span></code> to remove all files generated by running +./configure script. After running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">distclean</span></code> your source tree (ideally) should look like the raw (just un-tarred) source -tree.</li> +tree.</p></li> </ul> -</div> -<div class="section" id="using-autoconf"> +</section> +<section id="using-autoconf"> <h2>Using autoconf<a class="headerlink" href="#using-autoconf" title="Permalink to this headline">¶</a></h2> <p>(If you are not a developer, you can ignore this section.)</p> <p>In the Kerberos V5 source directory, there is a configure script which automatically determines the compilation environment and creates the proper Makefiles for a particular platform. This configure script is generated using autoconf, which you should already have installed if -you will be making changes to <code class="docutils literal"><span class="pre">src/configure.in</span></code>.</p> +you will be making changes to <code class="docutils literal notranslate"><span class="pre">src/configure.in</span></code>.</p> <p>Normal users will not need to worry about running autoconf; the distribution comes with the configure script already prebuilt.</p> -<p>The autoconf package comes with a script called <code class="docutils literal"><span class="pre">autoreconf</span></code> that -will automatically run <code class="docutils literal"><span class="pre">autoconf</span></code> and <code class="docutils literal"><span class="pre">autoheader</span></code> as needed. You -should run <code class="docutils literal"><span class="pre">autoreconf</span></code> from the top source directory, e.g.:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">krb5</span><span class="o">-</span><span class="n">VERSION</span><span class="o">/</span><span class="n">src</span> +<p>The autoconf package comes with a script called <code class="docutils literal notranslate"><span class="pre">autoreconf</span></code> that +will automatically run <code class="docutils literal notranslate"><span class="pre">autoconf</span></code> and <code class="docutils literal notranslate"><span class="pre">autoheader</span></code> as needed. You +should run <code class="docutils literal notranslate"><span class="pre">autoreconf</span></code> from the top source directory, e.g.:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">u1</span><span class="o">/</span><span class="n">krb5</span><span class="o">-</span><span class="n">VERSION</span><span class="o">/</span><span class="n">src</span> <span class="n">autoreconf</span> <span class="o">--</span><span class="n">verbose</span> </pre></div> </div> -</div> -</div> +</section> +</section> + <div class="clearer"></div> </div> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">Doing the build</a><ul> @@ -245,6 +238,7 @@ should run <code class="docutils literal"><span class="pre">autoreconf</span></c <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -252,8 +246,8 @@ should run <code class="docutils literal"><span class="pre">autoreconf</span></c <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> |
