diff --git a/doc/index.docbook b/doc/index.docbook index 672d8f4..9351693 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -61,20 +61,120 @@ Introduction -&kdesvn-build; is a Perl script to help users install +&kdesvn-build; is a Perl script to help users install &kde; from &svn;. 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 kdesdk module. + + Getting Started -The first thing to do is to copy the ... bla bla bla. +In this chapter, we show how to use the &kdesvn-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. -Then you bla, bla, bla. + +All topics present in this chapter are covered with even more detail in the + +Building &kde; from Source Step by Step Guide, at the +&kde; Quality Team Website. +If you are compiling KDE for the first time, it is a good idea to read +it, or consult it as a reference source. You will find detailed information +about packaging tools and requirements, common compilation pitfalls and +strategies and information about running your new &kde; installation. + + + +Preparing the System to Build &kde; + +It is recommended that you download and build &kde; using a user +account. If you already have &kde; packages installed, the best choice +would be to create a different user to build and run the new &kde;. The +advantage of building &kde; as a user is you can not break the base +system, and you will always have a way to comfortably work when +things go wrong. + +Later, you can install it system wide as root. This document +does not cover a root installation, because if you are performing a system +wide install, you probably already know what you are doing. + + +Before using the &kdesvn-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), +the subversion (svn) client, the gcc compiler with C++ support, libxml2, +openssl, libbz2, and many more (for a complete list, visit the +KDE 3.4 Compilation +Requirements). You can usually get those tools packaged for your system +from your distribution or vendor. + + + +Some of these packages are divided into libs, programs or utilities and +development packages. You will need at least the program or library and +its development package. If in doubt, install all. The libraries you need +will change depending on the modules you intend to build, as each module +has its own requirements. The + +Building &kde; from Source Step by Step Guide has more details +about the specific tools and techniques used to install and find the +required software. + + + +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 +.kdesvn-build. 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 kdesvn-buildrc-sample file. +You can find more information about the sintax of the configuration file +in and in . + + + +A good way to get the latest version is to browse the kdesdk/scripts page +at the websvn.kde.org 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 +the latest version of the script. Do the same for the +kdesvn-buildrc-sample file. + + + + + + + +Setting the Configuration Data + +Bla Bla. + + + + + +Using the &kdesvn-build; script + +Bla Bla. + + + + +Setting the Environment to Run Your Fresh &kde; + +Bla Bla. + + @@ -112,8 +212,8 @@ specify: Automatically sets up a build system, with the source directory not the same as the build directory, in order to keep the source directory -pristine. The exception is qt-copy, which isn't designed to be built like -that (unless you'd like to test the +pristine. The exception is qt-copy, which isn not designed to be built like +that (unless you would like to test the qt with a separate build directory hack). You can specify global options to apply to every module to check out, and @@ -132,9 +232,9 @@ and CXXFLAGS. log of a script run. Also, a special symlink called latest is created to always point to the most recent log entry in the log directory. -If you're using a user build of &kde; instead of a system build (for which +If you are using a user build of &kde; instead of a system build (for which you must be root to install), you can use the script to install for you. I -haven't audited this code, and it makes ample use of the system() +haven not audited this code, and it makes ample use of the system() call, so I would not recommend running it as root at this point. You can use make-install-prefix to @@ -163,11 +263,11 @@ modules. This work still needs to be completed. Things that &kdesvn-build; does NOT do: -Find the fastest &kde; &svn; mirror. There isn't even a list shipped +Find the fastest &kde; &svn; mirror. There isn not even a list shipped with the script at this point, although the default server should work fine. Brush your teeth. You should remember to do that yourself. -The script probably isn't bug-free. Sorry. +The script probably isn not bug-free. Sorry. @@ -176,7 +276,7 @@ fine. The Format of .kdesvn-buildrc To use the script, you must have a file in your home directory called -.kdesvn-buildrc, which describes the modules you'd like to download and +.kdesvn-buildrc, which describes the modules you would like to download and build.