From 7db0d982d25d429a4852b4e966602639cd9a0f6c Mon Sep 17 00:00:00 2001 From: Michael Pyne Date: Wed, 7 Sep 2011 15:50:22 -0400 Subject: [PATCH] doc: Change repo URL, mention new kdesrc-build-setup --- doc/index.docbook | 60 ++++++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/doc/index.docbook b/doc/index.docbook index ae3ae8a..cf92a9a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -280,27 +280,28 @@ in your system. However, if you do not, you can download it from &kdesrc-build; home page, or you can find it from its home in the &kde; source repository. -&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. +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 to &kdesrc-build; as a quick +way to verify this. To download &kdesrc-build; from its home page, simply go to the &kdesrc-build; home page and download the latest appropriate release. The release is packaged as a compressed tarball archive, which you can extract using &ark; or tar. The contents of the archive include the actual -&kdesrc-build; script, and a sample configuration file -(kdesrc-buildrc-sample). +&kdesrc-build; script, a sample configuration file +(kdesrc-buildrc-sample), and a quick-setup +program. Or, you can obtain &kdesrc-build; from its source repository, -located at: http://websvn.kde.org/trunk/KDE/kdesdk/scripts/. -This is the &kde; Software Development Kit scripting directory, which is the -home of &kdesrc-build;. You can click on the kdesrc-build 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 kdesrc-buildrc-sample -if you need to. +located at: http://quickgit.kde.org/?p=kdesrc-build.git&a=tree&hb=refs/heads/master. +You can click on the kdesrc-build entry which will bring +you to a page where you can download the latest revision. Click on the +plain link for the file to download it directly, and save it to +a convenient spot on your hard disk. Do the same for +kdesrc-buildrc-sample if you need to. 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. Prepare the configuration file -Although &kdesrc-build; does not require you to create a configuration file, it -makes the work flow much easier. Using a configuration file, 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 -configuration file. - -The configuration file should be called .kdesrc-buildrc. -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 kdesrc-buildrc-sample file, which -you can copy over as ~/.kdesrc-buildrc and then edit. - +&kdesrc-build; uses a configuration +file (located at ~/.kdesrc-buildrc) to control +which modules are built, where they are installed to, etc. + +You can use a program included with &kdesrc-build;, called +kdesrc-build-setup in order to prepare a simple +kdesrc-build configuration. You can then edit the +~/.kdesrc-buildrc from there to make any changes you see +fit. + +kdesrc-build-setup 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. + +You can use the included kdesrc-buildrc-sample +sample configuration to get explanations as to the various options available. + You can find more information about the syntax of the configuration file in and in .