summaryrefslogtreecommitdiffstats
path: root/NAMING
diff options
context:
space:
mode:
Diffstat (limited to 'NAMING')
-rw-r--r--NAMING75
1 files changed, 75 insertions, 0 deletions
diff --git a/NAMING b/NAMING
new file mode 100644
index 000000000..cd3c5ae80
--- /dev/null
+++ b/NAMING
@@ -0,0 +1,75 @@
+This document describes the naming convention for the various kinds
+of DSOs (Dynamic Shared Objects).
+
+NOTE: Files of the format xxxx.la are libtool files that describe the
+actual DSO. The DSO itself is usually named xxxx.so or libxxxx.so.
+Some platforms require that the name of a DSO starts with "lib". On
+those platforms xxxx.la and libxxxx.la both generate DSOs with the
+same name "libxxxx.so". Since this leads to problems you should never
+use both "xxxx.la" and "libxxxx.la" as names for DSOs!!
+
+*** Since <appname>.la is reserved for KDEInit loadable modules, it is
+*** strongly recommended NEVER to use lib<appname>.la as the name of a
+*** library.
+
+
+KDEInit Loadable Modules
+========================
+Name: <appname>.la
+Definition: kdeinit_LTLIBRARIES = <appname>.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+KParts
+======
+Name: lib<appname>part.la
+Definition: kde_module_LTLIBRARIES = lib<appname>part.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+KImageIO plugin
+===============
+Name: kimg_<imageformat>.la
+Definition: kde_module_LTLIBRARIES = kimg_<imageformat>.la
+LDFLAGS: -module $(KIMGIO_PLUGIN)
+
+
+KWin plugin
+===========
+Name: kwin3_<clientname>.la
+Definition: kde_module_LTLIBRARIES = kwin3_<clientname>.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+KIOSlave
+========
+Name: kio_<protocol>.la
+Definition: kde_module_LTLIBRARIES = kio_<protocol>.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+KControl Module
+===============
+Name: kcm_<modulename>.la
+Definition: kde_module_LTLIBRARIES = kcm_<modulename>.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+KDED Module
+===========
+Name: kded_<modulename>.la
+Definition: kde_module_LTLIBRARIES = kded_<modulename>.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+Kicker Applet
+=============
+Name: <appletname>_panelapplet.la
+Definition: kde_module_LTLIBRARIES = <appletname>_panelapplet.la
+LDFLAGS: -module $(KDE_PLUGIN)
+
+
+A definition like kde_module_LTLIBRARIES = <Name>
+means that the module is installed under $(kde_moduledir),
+which is $prefix/lib/kde3/ in KDE3.
+