[kde-services-devel] r491 - trunk/hotstuff

[josef at new.kstuff.org]

Author: josef
Date: 2008-11-23 10:47:14 +0100 (Sun, 23 Nov 2008)
New Revision: 491

Added:
   trunk/hotstuff/svn-repos.txt
Log:
- documentation on SVN-backed repositories



Added: trunk/hotstuff/svn-repos.txt
===================================================================
--- trunk/hotstuff/svn-repos.txt	                        (rev 0)
+++ trunk/hotstuff/svn-repos.txt	2008-11-23 09:47:14 UTC (rev 491)
@@ -0,0 +1,33 @@
+Information on SVN-backed GHNS repositories
+===========================================
+
+GHNS entries can take several paths until they end up in a GHNS repository.
+They could be uploaded by FTP, manually or through the KNS2 upload dialogue,
+or they can be maintained through SVN. The latter means that users are not
+able to upload easily, but it's a suitable mode for application maintainers
+who want to keep control of what data is being offered.
+
+On newstuff.kde.org, a repository is available for hosting entries. Any
+other repository can also be used, in this case newstuff.kde.org only
+maintains the provider meta information.
+The repository URLs are:
+  svn://newstuff.kde.org/kdedata/trunk
+  http://newstuff.kde.org/kdedata/browser/trunk
+
+Two types of information are stored there: an ADMIN directory, and directories
+for the applications and data types. For new applications, a new configuration
+file needs to be created in ADMIN/hotstuff.d. Other than that, this complicated
+part is not really needed.
+
+In each application directory, new entries and changes can be committed at
+any time. They will be picked up by Hotstuff automatically every minute or
+every couple of minutes. The SVN scripts will automatically perform some sanity
+checks. Here are the rules:
+ - Each entry needs to have a .meta file, for syntax please look here:
+   http://ghns.freedesktop.org/spec/ghns-spec.html
+ - Each entry also needs to have a payload file. If multiple files are needed,
+   create an archive out of them.
+ - Each entry can optionally have a preview file.
+ - Payload and preview are referenced without path information from the .meta
+   file.
+