rev 13706 - people/sune/doc/kde-policy

Mon Feb 2 01:13:00 UTC 2009

Author: pusling-guest
Date: 2009-02-02 01:13:00 +0000 (Mon, 02 Feb 2009)
New Revision: 13706

Added:
   people/sune/doc/kde-policy/packaging.tex
Modified:
   people/sune/doc/kde-policy/apps.tex
   people/sune/doc/kde-policy/kde-policy.tex
   people/sune/doc/kde-policy/non-apps.tex
   people/sune/doc/kde-policy/preface.tex
Log:
style and content updates based on feedback on irc

Modified: people/sune/doc/kde-policy/apps.tex
===================================================================

--- people/sune/doc/kde-policy/apps.tex	2009-02-02 01:00:20 UTC (rev 13705)
+++ people/sune/doc/kde-policy/apps.tex	2009-02-02 01:13:00 UTC (rev 13706)
@@ -3,11 +3,11 @@
 \section{Naming}
 
 All applications should be named as close to upstream project name, and if a version of a application using KDE3 libraries and a version using KDE4 libraries
-is expected to coexist during the release cycle of ``Debian Squeeze'', the name of the application using KDE3 libraries should be versioned.
+is expected to coexist during the release cycle of ``Debian Squeeze'', the package name of the application using KDE3 libraries must be versioned.
 
 \section{Description}
 
-All packages should have a clear description that describes what the program do. The prases "... for KDE" or "... for KDE 4" should be avoided, unless
+All packages should have a clear description that describes what the program do. The prases "\ldots for KDE" or "\ldots for KDE 4" should be avoided, unless
 it is a package that doesn't make sense outside the KDE Desktop itself.
 
 \section{Sections}
@@ -17,7 +17,7 @@
 
 \section{Dependecies}
 
-Applications using the graphic user interface parts KDE Libraries must depend on the kdebase-runtime package, as this package contains
+Applications using the graphic user interface parts KDE Libraries must depend on the \emph{kdebase-runtime} package, as this package contains
 data that the KDE Libraries expect to be available as well as some commands that KDE Libraries and application using KDE Libraries expects
 to be around and uses unconditionally.
 The shlibs system of the KDE library packages should make sure that this is in place, but if the application for some reason doesn't 

Modified: people/sune/doc/kde-policy/kde-policy.tex
===================================================================
--- people/sune/doc/kde-policy/kde-policy.tex	2009-02-02 01:00:20 UTC (rev 13705)
+++ people/sune/doc/kde-policy/kde-policy.tex	2009-02-02 01:13:00 UTC (rev 13706)
@@ -14,6 +14,7 @@
 \include{preface}
 \include{apps}
 \include{non-apps}
+\include{packaging}
 
 
 \end{document}

Modified: people/sune/doc/kde-policy/non-apps.tex
===================================================================
--- people/sune/doc/kde-policy/non-apps.tex	2009-02-02 01:00:20 UTC (rev 13705)
+++ people/sune/doc/kde-policy/non-apps.tex	2009-02-02 01:13:00 UTC (rev 13706)
@@ -9,11 +9,11 @@
 \item Widget styles 
 \item Window decorations 
 \end{itemize}
-And in KDE3 series, these was named ``kde-icon-something'', ``kde-style-something''
-and ``kwin-style-something''. If a source package built both a
+And in KDE3 series, these was named \emph{kde-icon-something}, \emph{kde-style-something}
+and \emph{kwin-style-something}. If a source package built both a
 widget style and a window decoration, the package could either build
 two binaries, if a dependency on the KDE window manager was to be
-avoided, or in one package named ``kde-style-something''
+avoided, or in one package named \emph{kde-style-something}
 
 \section{Names}
 
@@ -28,31 +28,37 @@
 \item Plasma applets
 \item KIO slaves
 \end{itemize}
-Icon themes should be named as ``kde-icon-something'' if it is
+Icon themes should be named as \emph{kde-icon-something} if it is
 a kde icon theme. KDE these days try to follow the freedesktop icon
-specification.%
+specification.
 \footnote{http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html}
 
 The kde-icon-oxygen package is special though, as it also contains
 all fallback icons for a KDE environment and a few KDE specific icons.
 
-In general, third party icon themes should just be named something-icon-theme,
+In general, third party icon themes should just be named \emph{something-icon-theme},
 as they are usable in several desktop environments.
 
-A KDE widget style should be named ``kde-style-something'', and
-a window decoration for the KDE Window Manager should be named kwin-style-something.
+A KDE widget style must be named \emph{kde-style-something}, and
+a window decoration for the KDE Window Manager must be named \emph{kwin-style-something}.
 A binary package should in general not contain both a window decoration
-and a widget style. Examples: kde-style-skulpture, kwin-style-skulpture.
+and a widget style. \textbf{Examples}: kde-style-skulpture, kwin-style-skulpture.
 
-Plasma dataengines should be in a plasma-dataengine-something, just as Plasma applets should be in 
-a package called plasma-applet-something, and Plasma scriptengines should be in a plasma-scriptengine-something
-package. Examples: plasma-applet-weather
+Plasma dataengines must be in a \emph{plasma-dataengine-something}, just as Plasma applets must be in 
+a package called \emph{plasma-applet-something}, and Plasma scriptengines must be in a \emph{plasma-scriptengine-something}
+package. If a data engine is specific to a applet and for now not meant to be shared among several applets, 
+the dataengine can be put into the same package as the applet.
+Plasma containments can also be packages in a \emph{plasma-containment-something} package, if a \emph{plasma-applet-something} 
+package isn't accurate enough.
+\textbf{Examples:} plasma-applet-weather
+Collections, as a source package building several related plasma parts, can be put in packages with a plural on the type, 
+\textbf{Examples:} plasma-applets-workspace
 
-Third party KIO slaves should be placed in kio-something packages. Example: kio-ftps.
+Third party KIO slaves should be placed in kio-something packages. \textbf{Example:} kio-ftps.
 
 \section{Descriptions}
 
-The description of the widget styles and the window decoration can contain a "... for KDE" in the description, as these 
+The description of the widget styles and the window decoration can contain a "\ldots for KDE" in the description, as these 
 are specific to the group of KDE apps and usage of the KDE window manager.
 KIO-slaves are used for all sorts of applications using KDE libraries and plasma thingies are also in the future to be shared
 by multiple applications, and thus not specific to the KDE Desktop.

Added: people/sune/doc/kde-policy/packaging.tex
===================================================================
--- people/sune/doc/kde-policy/packaging.tex	                        (rev 0)
+++ people/sune/doc/kde-policy/packaging.tex	2009-02-02 01:13:00 UTC (rev 13706)
@@ -0,0 +1,16 @@
+\chapter{Packaging recommendation}
+
+\section{Intro}
+
+This chapter describes some recommendations on how to package applications built against libraries
+from version 4 of the K Desktop Environment.
+
+\section{Pkg-kde-tools}
+It is recommended for packages built against libraries of KDE 4 to build depend on pkg-kde-tools 
+and use the DEB\_CMAKE\_KDE4\_FLAGS variable as specified in 
+\emph{/usr/share/pkg-kde-tools/makefiles/1/variables.mk} to get the default arguments for CMake for 
+such packages. Please see \emph{/usr/share/doc/pkg-kde-tools/README.Debian} for more documentation
+
+The \emph{variables.mk} snippet is for anyone packaging such applications. Some people prefers 
+a build system called ``CDBS'', and \emph{/usr/share/pkg-kde-tools/makefiles/1/cdbs/kde.mk} is for such 
+usage.

Modified: people/sune/doc/kde-policy/preface.tex
===================================================================
--- people/sune/doc/kde-policy/preface.tex	2009-02-02 01:00:20 UTC (rev 13705)
+++ people/sune/doc/kde-policy/preface.tex	2009-02-02 01:13:00 UTC (rev 13706)
@@ -11,3 +11,5 @@
 debian ships a KDE4 KDE Desktop.
 
 The packages that are part of the official KDE releases does not yet fully adhere to this policy document, but is converging towards it.
+
+This document uses shall and must and so on as defined in RFC 2119 \footnote{http://www.ietf.org/rfc/rfc2119.txt}


