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.

Important

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.

Note

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 access the KDE source repository do not accidentally forget to leave the SSH Agent tool enabled. This can cause Kdesvn-build to hang indefinitely waiting for the developer to type in their SSH password, so by default, Kdesvn-build will check if the Agent is running before performing source updates.

Note

This is only done for KDE developers using SSH. This is because no password is required for the default anonymous checkout. Subversion will handle passwords for the second possible protocol for KDE developers, https.

You may wish to disable the SSH Agent check, in case of situations where Kdesvn-build is mis-detecting the presence of an agent. To disable the agent check, set the disable-agent-check option to true.

Disabling the SSH agent check:

global
  disable-agent-check true
end global