doc: Change repo URL, mention new kdesrc-build-setup

wilder
Michael Pyne 15 years ago
parent da61452314
commit 7db0d982d2
  1. 60
      doc/index.docbook

@ -280,27 +280,28 @@ in your system. However, if you do not, you can download it from
<ulink url="http://kdesrc-build.kde.org/">&kdesrc-build; home page</ulink>,
or you can find it from its home in the &kde; source repository.</para>
<note><para>&kdesrc-build; is included with the kdesdk module, and the module
is often installed by distributions already. If you have downloaded
&kdesrc-build; ensure that you are using the version you downloaded. You can
use the --version option to be sure you are running the version you think
you are.</para></note>
<tip><para>If you use a more recent &kdesrc-build; by downloading from its
website, you should remember to run the &kdesrc-build; script you downloaded.
You can use the <option>--version</option> option to &kdesrc-build; as a quick
way to verify this.</para></tip>
<orderedlist>
<listitem><para>To download &kdesrc-build; from its home page, simply go to the
<ulink url="http://kdesrc-build.kde.org/">&kdesrc-build; home page</ulink> and download the latest appropriate release. The release is
packaged as a compressed tarball archive, which you can extract using &ark; or
<command>tar</command>. The contents of the archive include the actual
&kdesrc-build; script, and a sample configuration file
(<filename>kdesrc-buildrc-sample</filename>).</para></listitem>
&kdesrc-build; script, a sample configuration file
(<filename>kdesrc-buildrc-sample</filename>), and a quick-setup
program.</para></listitem>
<listitem><para>Or, you can obtain &kdesrc-build; from its source repository,
located at: <ulink url="http://websvn.kde.org/trunk/KDE/kdesdk/scripts/">http://websvn.kde.org/trunk/KDE/kdesdk/scripts/</ulink>.
This is the &kde; Software Development Kit scripting directory, which is the
home of &kdesrc-build;. You can click on the <filename>kdesrc-build</filename> entry which will
bring you to a page where you can download the latest revision. Do so, and
save it to a convenient spot on your hard disk. Do the same for <filename>kdesrc-buildrc-sample</filename>
if you need to.</para></listitem>
located at: <ulink
url="http://quickgit.kde.org/?p=kdesrc-build.git&amp;a=tree&amp;hb=refs/heads/master">http://quickgit.kde.org/?p=kdesrc-build.git&amp;a=tree&amp;hb=refs/heads/master</ulink>.
You can click on the <filename>kdesrc-build</filename> entry which will bring
you to a page where you can download the latest revision. Click on the
<quote>plain</quote> link for the file to download it directly, and save it to
a convenient spot on your hard disk. Do the same for
<filename>kdesrc-buildrc-sample</filename> if you need to.</para></listitem>
</orderedlist>
<para>No matter which technique you use, you need to make sure that the
@ -313,22 +314,23 @@ was not found, or you may run a previously-installed version by mistake.</para>
<sect3 id="setup-rcfile">
<title>Prepare the configuration file</title>
<para>Although &kdesrc-build; does not require you to create a <link linkend="configure-data">configuration file</link>, it
makes the work flow much easier. Using a <link linkend="configure-data">configuration file</link>, you can control which
modules are installed, or remove modules you do not want to install. &kdesrc-build;
by default installs a useful &kde; installation using very generic installation
flags, which may be different from your needs. So it is best to use a
<link linkend="configure-data">configuration file</link>. </para>
<para>The <link linkend="configure-data">configuration file</link> should be called <filename>.kdesrc-buildrc</filename>.
This file should be installed on
the home folder (<filename class="directory">~/</filename>), and contain all configuration data
required for the script to run, like configuration options,
compiling options, location of the sources, the destination of the installation
(prefix), the modules that should be built, &etc;. The default configuration
data is provided by the <filename>kdesrc-buildrc-sample</filename> file, which
you can copy over as <filename>~/.kdesrc-buildrc</filename> and then edit.
</para>
<para>&kdesrc-build; uses a <link linkend="configure-data">configuration
file</link> (located at <filename>~/.kdesrc-buildrc</filename>) to control
which modules are built, where they are installed to, etc.</para>
<para>You can use a program included with &kdesrc-build;, called
<application>kdesrc-build-setup</application> in order to prepare a simple
kdesrc-build configuration. You can then edit the
<filename>~/.kdesrc-buildrc</filename> from there to make any changes you see
fit.</para>
<para><application>kdesrc-build-setup</application> itself runs from a terminal
(instead of using a graphical interface), just like &kdesrc-build;, so you can
use it even if you have no graphical interface available yet.</para>
<tip><para>You can use the included <filename>kdesrc-buildrc-sample</filename>
sample configuration to get explanations as to the various options available.
</para></tip>
<para>You can find more information about the syntax of the <link linkend="configure-data">configuration file</link>
in <xref linkend="configure-data" /> and in <xref linkend="kdesrc-buildrc" />.

Loading…
Cancel
Save