diff options
Diffstat (limited to 'doc/scripts/kdesvn-build/index.docbook')
| -rw-r--r-- | doc/scripts/kdesvn-build/index.docbook | 136 |
1 files changed, 68 insertions, 68 deletions
diff --git a/doc/scripts/kdesvn-build/index.docbook b/doc/scripts/kdesvn-build/index.docbook index e54dbb9b..4ae84648 100644 --- a/doc/scripts/kdesvn-build/index.docbook +++ b/doc/scripts/kdesvn-build/index.docbook @@ -1,17 +1,17 @@ <?xml version="1.0" ?> <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ - <!ENTITY kappname "kdesvn-build"> - <!ENTITY package "kdesdk"> + <!ENTITY kappname "tdesvn-build"> + <!ENTITY package "tdesdk"> <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> <!-- Change language only here --> <!ENTITY svn "<application>Subversion</application>"> - <!ENTITY kdesvn-build "<application>kdesvn-build</application>"> + <!ENTITY tdesvn-build "<application>tdesvn-build</application>"> ]> <book lang="&language;"> <bookinfo> -<title>&kdesvn-build; Script Manual</title> +<title>&tdesvn-build; Script Manual</title> <authorgroup id="authors"> <author> @@ -45,12 +45,12 @@ <releaseinfo>0.98</releaseinfo> <abstract> -<para>The &kdesvn-build; is a Perl script which builds and installs &kde; directly from the sources found in the &kde; &svn; repository.</para> +<para>The &tdesvn-build; is a Perl script which builds and installs &kde; directly from the sources found in the &kde; &svn; repository.</para> </abstract> <keywordset> <keyword>KDE</keyword> -<keyword>kdesdk</keyword> +<keyword>tdesdk</keyword> <keyword>SVN</keyword> <keyword>Subversion</keyword> <keyword>KDE development</keyword> @@ -63,18 +63,18 @@ <title>Introduction</title> <para> -&kdesvn-build; is a Perl script to help users install <ulink +&tdesvn-build; is a Perl script to help users install <ulink url="http://www.kde.org/">&kde;</ulink> from <ulink url="http://subversion.tigris.org/">&svn;</ulink>. You may also want to -consider the kde-build script include with &kde;'s kdesdk module. +consider the kde-build script include with &kde;'s tdesdk module. </para> <para> -Here we document the &kdesvn-build; configuration file syntax and options, its +Here we document the &tdesvn-build; configuration file syntax and options, its command line options, features, and an overview of all necessary steps required to build &kde; from source, including the steps which you should perform using other tools, or in other words, steps that are not automatically performed -by the &kdesvn-build; script. +by the &tdesvn-build; script. </para> </chapter> @@ -83,7 +83,7 @@ by the &kdesvn-build; script. <title>Getting Started</title> <para> -In this chapter, we show how to use the &kdesvn-build; to checkout modules from the +In this chapter, we show how to use the &tdesvn-build; to checkout modules from the &kde; repository and build them. We also provide a basic explanation of the &kde; &svn; structure and the steps you have to perform before running the script. </para> @@ -117,7 +117,7 @@ does not cover a root installation. If you are performing a system wide install, you probably already know what you are doing anyway. </para> -<para>Before using the &kdesvn-build; script (or any other building +<para>Before using the &tdesvn-build; script (or any other building strategy) you must install the development tools and libraries needed for &kde;. You need the Qt library, version 3.3.0 or greater, Automake 1.8, Autoconf 2.5X (better if >=2.57 as a bug was reported with lower versions), @@ -141,25 +141,25 @@ required software. </para> <para> -You probably already have a version of the &kdesvn-build; script installed -in your system. &kdesvn-build;requires you to create a configuration file, named -<filename>.kdesvn-buildrc</filename>. This file should be installed on +You probably already have a version of the &tdesvn-build; script installed +in your system. &tdesvn-build;requires you to create a configuration file, named +<filename>.tdesvn-buildrc</filename>. This file should be installed on the home folder (~/), 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>kdesvn-buildrc-sample</filename> file. +data is provided by the <filename>tdesvn-buildrc-sample</filename> file. You can find more information about the syntax of the configuration file -in <xref linkend="configure-data" /> and in <xref linkend="kdesvn-buildrc" />. +in <xref linkend="configure-data" /> and in <xref linkend="tdesvn-buildrc" />. </para> <para> -A good way to get the latest version is to browse the kdesdk/scripts page +A good way to get the latest version is to browse the tdesdk/scripts page at the <ulink url="http://websvn.kde.org/trunk/KDE">websvn.kde.org</ulink> website. -You will see a list of the files available in the kdesdk/scripts directory in -the &kde; &svn; repository. Click the &kdesvn-build; link and download +You will see a list of the files available in the tdesdk/scripts directory in +the &kde; &svn; repository. Click the &tdesvn-build; link and download the latest version of the script. Do the same for the -<filename>kdesvn-buildrc-sample</filename> file. +<filename>tdesvn-buildrc-sample</filename> file. Make the script executable, and be sure it is in your path. </para> @@ -170,12 +170,12 @@ Make the script executable, and be sure it is in your path. <para> To use the script, you must have a file in your home directory called -<filename>.kdesvn-buildrc</filename>, which sets the general options and sets the modules +<filename>.tdesvn-buildrc</filename>, which sets the general options and sets the modules you would like to download and build. </para> <para> -Use the <filename>kdesvn-buildrc-sample</filename> file as a +Use the <filename>tdesvn-buildrc-sample</filename> file as a template, setting global options, and the modules you want to build. </para> @@ -193,26 +193,26 @@ Pay close attention to the kdedir and qtdir global variables, as the first sets where your &kde; build is going to be installed, (by default to <filename>~/kde</filename>), and the second where (and if) your qt library is going to be built and installed, (by default to -<filename>~/kdesvn/build/qt-copy</filename>). You will need to know the +<filename>~/tdesvn/build/qt-copy</filename>). You will need to know the kdedir and qtdir location later, to set up the environment variables that are necessary to run your new installation. Check if the listed modules are in fact the modules you want to build. -The default options from the <filename>kdesvn-buildrc-sample</filename> file +The default options from the <filename>tdesvn-buildrc-sample</filename> file should be enough to get a fairly complete &kde; installation. -Save the resulting as <filename>.kdesvn-buildrc</filename> in your home +Save the resulting as <filename>.tdesvn-buildrc</filename> in your home folder. </para> <para> -If you wish to fine tune your <filename>.kdesvn-buildrc</filename>, -consult <xref linkend="kdesvn-buildrc" /> for detailed information +If you wish to fine tune your <filename>.tdesvn-buildrc</filename>, +consult <xref linkend="tdesvn-buildrc" /> for detailed information about all configuration options. </para> </sect1> <sect1 id="building-and-troubleshooting"> -<title>Using the &kdesvn-build; script</title> +<title>Using the &tdesvn-build; script</title> <para> Now you are ready to run the script. From a terminal window, @@ -220,7 +220,7 @@ log in to the user you are using to compile &kde; and execute the script: <screen> <prompt>%</prompt><command>su</command> <option>-</option> <replaceable>devel-username</replaceable> -<prompt>%</prompt><command>kdesvn-build</command> +<prompt>%</prompt><command>tdesvn-build</command> </screen> </para> @@ -353,7 +353,7 @@ the stable KDE desktop. <title>Script Features</title> <para> -&kdesvn-build; features include: +&tdesvn-build; features include: </para> @@ -391,7 +391,7 @@ support. <listitem><para> Tilde-expansion for your configuration options. For example, you can specify: -<programlisting>qtdir ~/kdesvn/build/qt-copy</programlisting> +<programlisting>qtdir ~/tdesvn/build/qt-copy</programlisting> </para></listitem> <listitem><para> @@ -415,7 +415,7 @@ you can specify options to apply to individual modules as well. Since the autotools sometimes get out of sync with changes to the source tree, you can force a rebuild of a module by creating a file called .refresh-me in the build directory of the module in question, or by running -&kdesvn-build; with the <option>--refresh-build</option> option. +&tdesvn-build; with the <option>--refresh-build</option> option. </para></listitem> <listitem><para> @@ -473,7 +473,7 @@ configuration option</link>. </itemizedlist> <para> -Things that &kdesvn-build; does NOT do: +Things that &tdesvn-build; does NOT do: </para> <itemizedlist> @@ -496,12 +496,12 @@ The script probably is not bug-free. Sorry. </chapter> -<chapter id="kdesvn-buildrc"> -<title>The Format of .kdesvn-buildrc</title> +<chapter id="tdesvn-buildrc"> +<title>The Format of .tdesvn-buildrc</title> <para> To use the script, you must have a file in your home directory called -<filename>.kdesvn-buildrc</filename>, which describes the modules you would +<filename>.tdesvn-buildrc</filename>, which describes the modules you would like to download and build. </para> @@ -532,7 +532,7 @@ end module <para> <replaceable>module-name</replaceable> must be a module from the &kde; &svn; repository (for -example, kdelibs or kdebase). Some options override global options, some +example, tdelibs or tdebase). Some options override global options, some add to global options, and some global options simply can't be overridden. </para> @@ -553,7 +553,7 @@ authors using the address you can find <link linkend="authors">above</link>. <listitem><para><link linkend="conf-configure-flags">configure-flags</link> to define what flags to configure a module with.</para></listitem> <listitem><para><link linkend="conf-cxxflags">cxxflags</link> to define the <envar>CXXFLAGS</envar> variable.</para></listitem> <listitem><para><link linkend="conf-dest-dir">dest-dir</link> to change the directory name for a module.</para></listitem> -<listitem><para><link linkend="conf-disable-agent-check">disable-agent-check</link>, to keep kdesvn-build from checking on ssh-agent's status.</para></listitem> +<listitem><para><link linkend="conf-disable-agent-check">disable-agent-check</link>, to keep tdesvn-build from checking on ssh-agent's status.</para></listitem> <listitem><para><link linkend="conf-do-not-compile">do-not-compile</link>, to mark directories to skip building.</para></listitem> <listitem><para><link linkend="conf-inst-apps">inst-apps</link>, to only build and install some directories.</para></listitem> <listitem><para><link linkend="conf-install-after-build">install-after-build</link>, to avoid installing after the build process.</para></listitem> @@ -569,7 +569,7 @@ authors using the address you can find <link linkend="authors">above</link>. <listitem><para><link linkend="conf-qtdir">qtdir</link>, to set the path to Qt.</para></listitem> <listitem><para><link linkend="conf-set-env">set-env</link>, to set an environment variable.</para></listitem> <listitem><para><link linkend="conf-source-dir">source-dir</link>, to change where to download the source code to.</para></listitem> -<listitem><para><link linkend="conf-stop-on-failure">stop-on-failure</link>, to make kdesvn-build stop as soon as a failure is encountered.</para></listitem> +<listitem><para><link linkend="conf-stop-on-failure">stop-on-failure</link>, to make tdesvn-build stop as soon as a failure is encountered.</para></listitem> <listitem><para><link linkend="conf-svn-server">svn-server</link>, to change the server the sources are downloaded from.</para></listitem> <listitem><para><link linkend="conf-use-qt-builddir-hack">use-qt-builddir-hack</link>, to give Qt a separate build directory from its source like KDE.</para></listitem> <listitem><para><link linkend="conf-use-unsermake">use-unsermake</link>, to use the advanced unsermake build system.</para></listitem> @@ -599,10 +599,10 @@ as well. <row id="conf-apidox"> <entry>apidox</entry> <entry>Overrides global</entry> -<entry>Set this option to <quote>true</quote> in order to have &kdesvn-build; automatically +<entry>Set this option to <quote>true</quote> in order to have &tdesvn-build; automatically build and install the API documentation for the module after the normal build/install process. This only works for modules where <command>make apidox</command> does something, -including kdelibs, kdebase, and koffice, among others. +including tdelibs, tdebase, and koffice, among others. </entry> </row> @@ -638,7 +638,7 @@ KDE 3.4 branch, you would set this option to "3.4".</para> <para>Note that some modules use a different branch name. Notably, the required arts module doesn't go by KDE version numbers. The arts that accompanied KDE 3.4 was version 1.4.</para> -<para>If kdesvn-build fails to properly download a branch with this option, you +<para>If tdesvn-build fails to properly download a branch with this option, you may have to manually specify the URL to download from using the <link linkend="conf-override-url">override-url</link> option.</para> </entry> @@ -698,8 +698,8 @@ set of configure options than the rest of &kde;, so this option <row id="conf-colorful-output"> <entry>colorful-output</entry> <entry>Can't be overridden</entry> -<entry>Set this option to false to disable the colorful output of &kdesvn-build;. -This option defaults to <quote>true</quote>. Note that &kdesvn-build; won't output the +<entry>Set this option to false to disable the colorful output of &tdesvn-build;. +This option defaults to <quote>true</quote>. Note that &tdesvn-build; won't output the color codes to anything but a terminal (such as xterm, &konsole;, or the normal Linux console). </entry> @@ -729,7 +729,7 @@ extragear-network using this option. <entry>disable-agent-check</entry> <entry>Can't be overridden</entry> <entry>Normally if you're using SSH to download the Subversion sources (such as -if you're using the svn+ssh protocol), kdesvn-build will try and make sure that +if you're using the svn+ssh protocol), tdesvn-build will try and make sure that if you're using ssh-agent, it is actually managing some SSH identities. This is to try and prevent SSH from asking for your passphrase for every module. You can disable this check by setting disable-agent-check to true. @@ -755,7 +755,7 @@ directive to choose directories that you want to check out.</para> <entry>email-address</entry> <entry>Can't be overridden</entry> <entry> -<para>Set this option to the e-mail address kdesvn-build should send from should +<para>Set this option to the e-mail address tdesvn-build should send from should it ever need to send e-mail. You do not need to worry about this if you don't use any feature which send e-mail. (They are all disabled by default). </para> @@ -771,13 +771,13 @@ needs this option. <entry>Can't be overridden</entry> <entry> <para>You can set this option to the email address to send a report to when a -module fails to build. kdesvn-build will wait until all the modules are done +module fails to build. tdesvn-build will wait until all the modules are done and collate all of the results in the report. The report is only sent if a module fails to build. </para> <para>Please see the <link linkend="conf-email-address">email-address</link> -option to set the address kdesvn-build should send from, since the default +option to set the address tdesvn-build should send from, since the default is usually not what you want. </para> </entry> @@ -887,11 +887,11 @@ option for a module, then you have pretty much commented it out. <row id="conf-module-base-path"> <entry>module-base-path</entry> <entry>Overrides global</entry> -<entry><para>Set this option to override &kdesvn-build;'s default directory path to the +<entry><para>Set this option to override &tdesvn-build;'s default directory path to the module in question. This can be used, for example, to pull specific branches or tagged versions of libraries. <ulink url="http://websvn.kde.org/">The &kde; Source Viewer</ulink> is invaluable in helping to pick the right path.</para> -<para>Note that &kdesvn-build; constructs the final path according to the +<para>Note that &tdesvn-build; constructs the final path according to the following template: <varname>$svn-server</varname>/home/kde/<varname>$module-base-path</varname>/<varname>$module-name</varname>. </para> @@ -904,25 +904,25 @@ following template: <entry>niceness</entry> <entry>Can't be overridden</entry> <entry>Set this option to a number between 20 and 0. The higher the number, the -lower a priority &kdesvn-build; will set for itself. The default is 10. +lower a priority &tdesvn-build; will set for itself. The default is 10. </entry> </row> <row id="conf-no-rebuild-on-fail"> <entry>no-rebuild-on-fail</entry> <entry>Overrides global</entry> -<entry>Set this option value to <quote>true</quote> to always prevent &kdesvn-build; from trying +<entry>Set this option value to <quote>true</quote> to always prevent &tdesvn-build; from trying to rebuild this module if it should fail an incremental build. Normally -&kdesvn-build; will try to rebuild the module from scratch to counteract the +&tdesvn-build; will try to rebuild the module from scratch to counteract the effect of a stray &svn; update messing up the build system.</entry> </row> <row id="conf-override-url"> <entry>override-url</entry> <entry>Overrides global</entry> -<entry>If you set this option, kdesvn-build will use its value as the URL +<entry>If you set this option, tdesvn-build will use its value as the URL to pass to Subversion <emphasis>completely unchanged</emphasis>. You should -generally use this if you want to download a specific release but kdesvn-build +generally use this if you want to download a specific release but tdesvn-build can't figure out what you mean using <link linkend="conf-branch">branch</link>. </entry> </row> @@ -957,7 +957,7 @@ installed. <para>Note that using this option can have a significant detrimental impact on both your bandwidth usage (if you use 'all') and the time taken to compile KDE, -since kdesvn-build will be unable to perform incremental builds.</para> +since tdesvn-build will be unable to perform incremental builds.</para> </entry> </row> @@ -981,7 +981,7 @@ globally).</para> <entry>Can't be overridden</entry> <entry>This option is used to set the directory on your computer to store the &kde; &svn; sources at. If you don't specify this value, the default is -<filename class="directory">~/kdesvn</filename>. If +<filename class="directory">~/tdesvn</filename>. If you do specify this value, use an absolute path name. </entry> </row> @@ -1010,7 +1010,7 @@ by default. to use this option. KDE releases are available in tarball form from <ulink url="ftp://ftp.kde.org/">The KDE FTP site</ulink> or one of <ulink url="http://download.kde.org/download.php">its mirrors</ulink>.</para> -<para>If you are using kdesvn-build because you have having trouble getting +<para>If you are using tdesvn-build because you have having trouble getting a KDE release to build on your distribution, consider using the <ulink url="http://developer.kde.org/build/konstruct/">Konstruct build tool</ulink> instead, which works from the release tarballs.</para> @@ -1023,7 +1023,7 @@ instead, which works from the release tarballs.</para> <entry>Although this option overrides the global option, it only makes sense for qt-copy. Set this option to <quote>true</quote> to enable the script's <emphasis>experimental</emphasis> srcdir != builddir mode. When enabled, -&kdesvn-build; will copy the qt-copy source module to the build directory, +&tdesvn-build; will copy the qt-copy source module to the build directory, and perform builds from there. That means your QTDIR environment variable should be set to <filename class="directory">$(qt-copy-build-dir)/qt-copy/lib</filename> @@ -1046,10 +1046,10 @@ script. This can lead to some serious decreases in build time, especially for systems</ulink>. This option defaults to <quote>true</quote> (for most modules). </para> -<para>Normally if you use this option kdesvn-build will automatically keep +<para>Normally if you use this option tdesvn-build will automatically keep unsermake up-to-date. This may start to get annoying, especially if you are managing unsermake yourself. If this is the case, you can set this option to -<quote>self</quote>, and kdesvn-build will still use unsermake, but will not +<quote>self</quote>, and tdesvn-build will still use unsermake, but will not do anything special to keep it updated. </para> </entry> @@ -1138,7 +1138,7 @@ Only output warnings and errors. <varlistentry id="cmdline-verbose"> <term><option>--verbose</option></term> <listitem><para> -Be very descriptive about what's going on, and what kdesvn-build is doing. +Be very descriptive about what's going on, and what tdesvn-build is doing. </para></listitem> </varlistentry> @@ -1199,7 +1199,7 @@ verbose about what they're doing in debugging mode. <term><option>--no-rebuild-on-fail</option></term> <listitem><para> don't try and -rebuild modules that have failed building from scratch. &kdesvn-build; will +rebuild modules that have failed building from scratch. &tdesvn-build; will never try to do this to a module that already was tried to be built from scratch. </para></listitem> @@ -1255,7 +1255,7 @@ other module names on the command line. <listitem><para> which interprets the next command line parameter as the file to read the configuration options from. The default -value for this parameter is ~/.kdesvn-buildrc. +value for this parameter is ~/.tdesvn-buildrc. </para></listitem> </varlistentry> @@ -1271,7 +1271,7 @@ This option implies <link linkend="cmdline-reconfigure"><option>--reconfigure</o <term><option>--build-system-only</option></term> <listitem><para> stop after running <command>make <option>-f</option> Makefile.cvs</command>. The configure -script will still need to be run, which &kdesvn-build; will do next time. This lets you +script will still need to be run, which &tdesvn-build; will do next time. This lets you prepare all the configure scripts at once so you can view the <command>./configure <option>--help</option></command> for each module, and edit your configure-flags accordingly. </para></listitem> @@ -1300,8 +1300,8 @@ linkend="conf-log-dir">log-dir</link> option, you would do: <listitem><para> You can use this option to override an option in your configuration file for a specific module. For instance, to override the <link -linkend="conf-use-unsermake">use-unsermake</link> option for kdemultimedia, you -would do: <option>--kdemultimedia,use-unsermake=false</option>. +linkend="conf-use-unsermake">use-unsermake</link> option for tdemultimedia, you +would do: <option>--tdemultimedia,use-unsermake=false</option>. </para></listitem> </varlistentry> |