Merge pull request #299 from sbt/wip/name-delegation-docs

Adding docs for name-delegation in #250

src/sphinx/DetailedTopics/docker.rst

@@ -15,7 +15,8 @@ Docker images require the following setting:
 
 .. code-block:: scala
 
-    maintainer in Linux := "John Smith <john.smith@example.com>"
+    import NativePackagerKeys._
+    maintainer in Docker := "John Smith <john.smith@example.com>"
 
 It may require these settings:
 

src/sphinx/DetailedTopics/index.rst

@@ -12,4 +12,5 @@ Advanced Topics
    redhat.rst
    debian.rst
    windows.rst
-   docker.rst
+   docker.rst
+   paths.rst

src/sphinx/DetailedTopics/paths.rst

@@ -0,0 +1,62 @@
+Path Configurations
+===================
+This section describes where and how to configure different kind of paths settings.
+
+- What is the installation location of my package
+- Where is the log directory created
+- What is the name of my start script
+- ...
+
+
+
+Quick Reference Table
+---------------------
+This table gives you a quick overview of the setting and the scope you should use.
+Paths which do not begin with a ``/`` are relative to the universal directory.
+The scopes are ordered from general to specific, so a more specific one will override
+the generic one. Only the listed scopes for a setting a relevant. Any changes in other
+scopes will have no effect!
+
+========================================================  ===================  =====================  =======
+output path                                               scopes               archetype              comment
+========================================================  ===================  =====================  =======
+lib                                                       all                  JavaApp
+conf                                                      all                  JavaApp
+bin/``<packageName>``                                     Global, Debian, Rpm  JavaApp
+bin/``<packageName>``                                     Docker                                      Entrypoint DockerPlugin
+bin/``<packageName>``.bat                                 Global               JavaApp
+``<defaultLinuxInstallationLocation>``/``<packageName>``  Linux, Debian, Rpm   JavaApp
+``<defaultLinuxLogLocation>``/``<packageName>``           Linux                JavaServerApplication
+logs                                                      Linux                JavaServerApplication  Symlink
+/etc/default/``<packageName>``                            Linux                JavaServerApplication
+/var/run/``<packageName>``                                Linux                JavaServerApplication
+/etc/init.d/``<packageName>``                             Linux, Debian, Rpm   JavaServerApplication  For SystemV
+/etc/init/``<packageName>``                               Linux, Debian, Rpm   JavaServerApplication  For Upstart
+/usr/lib/systemd/system/``<packageName>``.service         Linux, Debian, Rpm   JavaServerApplication  For Systemd
+``<defaultLinuxInstallLocation>``                         Docker                                      Installation path inside the container
+========================================================  ===================  =====================  =======
+
+
+
+
+Settings
+--------
+
+These settings configure the path behaviour
+
+  ``name``
+    Use for the normal jar generation process
+
+  ``normalizedName``
+    Use for the normal jar generation process.
+
+  ``packageName``
+    Defaults to ``normalizedName``. Can be override in different scopes
+
+  ``defaultLinuxInstallationLocation``
+    Defaults to ``/usr/share/``. Used to determine the installation path for for linux packages (rpm, debian)
+
+  ``defaultLinuxLogLocation``
+    Defaults to ``/var/log/``. Used to determine the log path for linux packages (rpm, debian).
+
+