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>, <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> 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 <tip><para>If you use a more recent &kdesrc-build; by downloading from its
is often installed by distributions already. If you have downloaded website, you should remember to run the &kdesrc-build; script you downloaded.
&kdesrc-build; ensure that you are using the version you downloaded. You can You can use the <option>--version</option> option to &kdesrc-build; as a quick
use the --version option to be sure you are running the version you think way to verify this.</para></tip>
you are.</para></note>
<orderedlist> <orderedlist>
<listitem><para>To download &kdesrc-build; from its home page, simply go to the <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 <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 packaged as a compressed tarball archive, which you can extract using &ark; or
<command>tar</command>. The contents of the archive include the actual <command>tar</command>. The contents of the archive include the actual
&kdesrc-build; script, and a sample configuration file &kdesrc-build; script, a sample configuration file
(<filename>kdesrc-buildrc-sample</filename>).</para></listitem> (<filename>kdesrc-buildrc-sample</filename>), and a quick-setup
program.</para></listitem>
<listitem><para>Or, you can obtain &kdesrc-build; from its source repository, <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>. located at: <ulink
This is the &kde; Software Development Kit scripting directory, which is the 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>.
home of &kdesrc-build;. You can click on the <filename>kdesrc-build</filename> entry which will You can click on the <filename>kdesrc-build</filename> entry which will bring
bring you to a page where you can download the latest revision. Do so, and you to a page where you can download the latest revision. Click on the
save it to a convenient spot on your hard disk. Do the same for <filename>kdesrc-buildrc-sample</filename> <quote>plain</quote> link for the file to download it directly, and save it to
if you need to.</para></listitem> a convenient spot on your hard disk. Do the same for
<filename>kdesrc-buildrc-sample</filename> if you need to.</para></listitem>
</orderedlist> </orderedlist>
<para>No matter which technique you use, you need to make sure that the <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"> <sect3 id="setup-rcfile">
<title>Prepare the configuration file</title> <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 <para>&kdesrc-build; uses a <link linkend="configure-data">configuration
makes the work flow much easier. Using a <link linkend="configure-data">configuration file</link>, you can control which file</link> (located at <filename>~/.kdesrc-buildrc</filename>) to control
modules are installed, or remove modules you do not want to install. &kdesrc-build; which modules are built, where they are installed to, etc.</para>
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 <para>You can use a program included with &kdesrc-build;, called
<link linkend="configure-data">configuration file</link>. </para> <application>kdesrc-build-setup</application> in order to prepare a simple
kdesrc-build configuration. You can then edit the
<para>The <link linkend="configure-data">configuration file</link> should be called <filename>.kdesrc-buildrc</filename>. <filename>~/.kdesrc-buildrc</filename> from there to make any changes you see
This file should be installed on fit.</para>
the home folder (<filename class="directory">~/</filename>), and contain all configuration data
required for the script to run, like configuration options, <para><application>kdesrc-build-setup</application> itself runs from a terminal
compiling options, location of the sources, the destination of the installation (instead of using a graphical interface), just like &kdesrc-build;, so you can
(prefix), the modules that should be built, &etc;. The default configuration use it even if you have no graphical interface available yet.</para>
data is provided by the <filename>kdesrc-buildrc-sample</filename> file, which
you can copy over as <filename>~/.kdesrc-buildrc</filename> and then edit. <tip><para>You can use the included <filename>kdesrc-buildrc-sample</filename>
</para> 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> <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" />. in <xref linkend="configure-data" /> and in <xref linkend="kdesrc-buildrc" />.

Loading…
Cancel
Save