[kde-doc-english] Re: Moving kremotecontrol's doc out of the kcontrol/ directory

[Burkhard Lück]

Am Montag, 21. März 2011, um 00:33:17 schrieb Raphael Kubo da Costa:
> Burkhard Lück <lueck at hube-lueck.de> writes:
> > Am Donnerstag, 3. März 2011, um 03:08:33 schrieb Raphael Kubo da Costa:
> >> Hi,
> >> 
> >> Still while working on the kdeutils git migration, I saw that
> >> kremotecontrol's documentation is in
> >> kdeutils/doc/kcontrol/kremotecontrol instead of
> >> kdeutils/doc/kremotecontrol.
> >> 
> >> After the git migration, it will probably move to a doc/ directory
> >> inside kremotecontrol itself. Do you know if there was any specific
> >> reason the documentation was inside an intermediate kcontrol/ directory,
> >> and if this directory will also be needed after the migration?
> > 
> > *All* kcm docs are in a subdir doc/kcontrol, see e.g, kdelibs,
> > kde-runtime, kde-workspace, same applies to kioslave documentation,
> > which is in doc/kioslave.
> > 
> > Some parts of the i18n toolchain in l10n-kde4/scripts need this
> > intermediate kcontrol/ directory to work properly, like e.g autogen.sh,
> > which generates the CMakeLists.txt files for the translated language
> > docbooks.
> 
> Hi again,
> 
> Another doubt related to this is whether a directory such as
> 'doc/kcontrol' is enough inside a repository such as 'kremotecontrol'.
> 
> Right now, `kdeutils/doc/kcontrol/blockdevices/' has become
> `kdf/doc/kcontrol' and `kdeutils/doc/kcontrol/kremotecontrol' has become
> `kremotecontrol/doc/kcontrol'.
> 
> Is this OK or do you need a subdirectory with the application name after
> `kcontrol'?
> 
Sorry I did not fully realize that kdf/kremotecontrol will become top level 
dirs in git repository.

Afaik it should be solved this way (see e.g. kgamma in kdegraphics):

1)
kdeutils/doc/kcontrol/blockdevices/ (svn) -> kdf/doc/ (git)
Change CMakeLists.txt in git to:
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en 
SUBDIR kcontrol/blockdevices

l10n-kde4/scripts/documentation_paths (trunk) gets an entry in module kdeutils
entry kcontrol/blockdevices git://anongit.kde.org/kdf.git HEAD:doc

2)
kdeutils/doc/kcontrol/kremotecontrol (svn) -> kremotecontrol/doc/ (git)
Change CMakeLists.txt in git to:
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en 
SUBDIR kcontrol/kremotecontrol

l10n-kde4/scripts/documentation_paths (trunk) gets an entry in module kdeutils
entry kcontrol/kremotecontrol git://anongit.kremotecontrol.org/ HEAD:doc

@Albert Astals Cid: is that ok?

-- 
Burkhard Lück