Location of docbooks in frameworks repos

Aleix Pol aleixpol at kde.org
Wed Mar 26 23:29:35 UTC 2014


On Wed, Mar 26, 2014 at 11:22 PM, Burkhard Lück <lueck at hube-lueck.de> wrote:

> Hi,
>
> a) In kde4 docbooks usually were located in a top level folder named "doc"
> in
> each repo, in frameworks this folder is named "docs" with an additional
> *s* ,
> where as the other repos with a frameworks branch seem to use the name
> "doc"
> (kate, kde-workspace as of now before the split etc.).
> That is possibly a bit confusing and error-prone editing
> documentation_paths?
>
> b) In kde4 we had a doc folder structure in each repo like:
>
> doc/app1/*docbook
> doc/app2/*docbook
> ...
> doc/kcontrol/kcm1/*docbook
> doc/kcontrol/kcm2/*docbook
> ...
> doc/kioslave/kio1/*docbook
> doc/kioslave/kio2/*docbook
> etc.
>
> Several scripts in l10n-kde4/script (docmessage extraction naming scheme,
> autogen.sh to generate all CMakeLists.txt for installation of language
> docbooks, update-xml to generate language docbooks) and the scripts on the
> kde
> documentation server docs.kde.org are based on such a consistent doc
> folder
> structure.
>
> I think we need a similar *consistent* scheme for docbook location in
> frameworks repos.
>
> --
> Burkhard Lück
>
> _______________________________________________
> Kde-frameworks-devel mailing list
> Kde-frameworks-devel at kde.org
> https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
>

For the moment, what I've been doing is to follow this. I've moved the
documentation into what will become the new repositories.

I think it's a good way to work since it lets us to be consistent, but if
somebody has a better idea then let's hear it.

Aleix
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140327/3faa9201/attachment-0001.html>


More information about the Kde-frameworks-devel mailing list