diff --git a/doc/index.docbook b/doc/index.docbook index c03b782..0bef6e6 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -92,8 +92,8 @@ &FDLNotice; -2008-01-14 -1.6 +2008-08-09 +1.6.3 &kdesvn-build; is a script which builds and installs &kde; directly from the sources found in the &kde; &subversion; repository. @@ -631,12 +631,6 @@ to your &kdesvn-build; &kde;. - -For developers: Supports building the API -documentation for a module. Note that this only works for &kde; 3 -modules when not using the &unsermake; script. - - Supports output message levels ranging from being very quiet to a full debug level. @@ -982,7 +976,6 @@ authors using the address you can find above. -apidox, to build API Documentation. apply-qt-patches, to enhance qt-copy. async, to update and build at the same time. binpath, to set the PATH variable. @@ -1040,17 +1033,13 @@ as well. apidox Overrides global - -Set this option to true in order to have &kdesvn-build; automatically -build and install the API documentation for the module after the normal build/install -process. This only works for modules where make apidox does something, -including kdelibs, kdebase and koffice, among others. - -This option does not work for modules using &unsermake; support, due to -deficiencies in the &unsermake; build system. This option does not work for -&kde; 4 modules because the required build system support has been migrated to -a different program which &kdesvn-build; has not been corrected to use yet. - +This option was used to allow for building KDE module API documentation. +It was removed in &kdesvn-build; 1.6.3 due to it not being supported in KDE 4. Online +API documentation is available from kde.org. +In addition it is possible to build KDE 4's API documentation using a script included in +the kdesdk module (/scripts directory). See KDE +TechBase for more details. It is still possible to manually build API documentation +for older modules of course. @@ -1159,7 +1148,7 @@ for all &kde; 4 modules, since they use &cmake; to build. Since these options are passed directly to the &cmake; command line, they should be given as they would be typed into &cmake;. For example: - cmake-options -DRPATH_STYLE=default + cmake-options -DKDE4_BUILD_TESTS=ON Since this is a hassle, &kdesvn-build; takes pains to ensure that as long @@ -1232,18 +1221,18 @@ disable this check by setting to do-not-compile Overrides global -Use this option to set the DO_NOT_COMPILE environment variable prior to -running the configure script. According to the &kde; -Developer FAQ, this should cause any top-level directory you pass to not be -built. The directories should be space-separated. +Use this option to select a specific set of directories to be built in a +module (instead of all of them). The directories to build should be space-separated. + +This feature is supported for both &kde; 3 and &kde; 4. KDE 4 support was added in +&kdesvn-build; 1.6.3. Note that the sources to the programs will still be downloaded. You can use the checkout-only directive to choose directories that you want to check out. -This option does not yet work with modules built using -&cmake;. +For example, to hold &juk; and &kscd; in the kdemultimedia module from +compiling, you would add "do-not-compile juk kscd" to your kdemultimedia settings. @@ -2682,54 +2671,6 @@ syntax is similar: --module,option-name< Features for &kde; developers - -Building API Documentation -&kdesvn-build; can automatically install additional documentation -generated from the sources in a module. This only works on some modules, -and is only useful for &kde; developers. - - -This feature does not work for modules built using the &unsermake; -build system. Since this is the default build system for modules that can -use &unsermake;, you would need to disable &unsermake; support. See example below for more information. - - - -To enable this, simply set the &apidox; option to true in the configuration file, -for the module that you would like documentation for. Not all modules have -documentation. Modules that do include kdelibs, kdebase and kdepim. - - - -If you have access to the Internet, the API documentation for &kde; is -also available online. In &konqueror;, you can use the shortcut kde:className. - - -You can also visit the &kde; documentation web site at English Breakfast Network. - - -Finally, it is possible to download the documentation in an archived -form, from The &kde; Developer's Corner. -Click on the &kde; version you want documented, and then you can download -an offline copy for the module you want. - - - - -Installing API Documentation for kdelibs: - - -module kdelibs - use-unsermake false # unsermake cannot build apidox - apidox true # build and install apidox -end module - - - - - &ssh; Agent checks &kdesvn-build; can ensure that &kde; developers that use &ssh; to @@ -2965,30 +2906,27 @@ beat out several competitors and was selected to be the build system for &kde; 4 autotools-based system that &kde; has used from the beginning. A introduction to &cmake; page is available on the &kde; Wiki. +url="http://techbase.kde.org/Development/Tutorials/CMake">&kde; TechBase. Basically, instead of running make Makefile.cvs, then configure, then &unsermake; (or &make;), we simply run &cmake; and then &make;. -&kdesvn-build; has initial support for &cmake;. A few features of &kdesvn-build; +&kdesvn-build; has support for &cmake;. A few features of &kdesvn-build; were really features of the underlying buildsystem, including inst-apps, configure-flags, and do-not-compile. When equivalent features are available, they are provided. For instance, the equivalent to the -configure-flags option is cmake-options. +configure-flags option is cmake-options, and the +do-not-compile option is also supported for &cmake; +as of &kdesvn-build; version 1.6.3. -However, some options, like inst-apps or do-not-compile, have no direct +However, some options (like inst-apps) have no direct equivalent, and are disabled. Should I find a way to implement them with &cmake; I will do so and re-enable the option. However, more or less everything works the same. -Not all of &kde; has been ported to use &cmake; at this point. For example, -the apidox option is rather useless until the -equivalent infrastructure is ready. I have tried to warn about such things but -not all deficiencies may be caught by &kdesvn-build; for now. -