Add a HOWTO, and clean up the example files. Right now the HOWTO only covers thandy-pk and thandy-server.

git-svn-id: file:///home/or/svnrepo/updater/trunk@17098 55e972cd-5a19-0410-ae62-a4d7a52db4cd

5 files changed, 40 insertions, 18 deletions

diff --git a/samples/bundle.cfg b/samples/bundle.cfg
deleted file mode 100644
index d2c78b3..0000000
--- a/samples/bundle.cfg
+++ /dev/null
@@ -1,15 +0,0 @@
-
-name = "example-bundle"
-version = [0,1,10]
-location = "/bundleinfo/example/os-arch/example-os-arch-0.1.10.txt"
-os = "os"
-arch = "arch"
-
-Package(name="example",
-	version=[0,1,2],
-	path="/pkginfo/example/rpm/example.txt",
-	order=(10,10,10),
-	optional=False)
-ShortGloss("en", "Example package is needed to make the ossifrage squeamish.")
-LongGloss("en", "You wouldn't want an unsqueamish ossifrage, would you?")
-
diff --git a/samples/example-bundle.cfg b/samples/example-bundle.cfg
new file mode 100644
index 0000000..9a9c2f5
--- /dev/null
+++ b/samples/example-bundle.cfg
@@ -0,0 +1,19 @@
+
+# The name of this bundle.
+name = "example-bundle"
+# Version of the bundle
+version = [0,1,10]
+# Where does it go in the repository?
+location = "/bundleinfo/example/rh9-x86/example-bundle-rh9-x86-0.1.10.txt"
+os = "rh9"
+arch = "arch"
+
+# This is one of the packages in the bundle.  There can be as many as you
+# like.
+Package(name="example",
+	order=(10,10,10),
+	optional=False)
+# The "Glosses" describe a package's purpose in the bundle.
+ShortGloss("en", "Example package is needed to make the ossifrage squeamish.")
+LongGloss("en", "You wouldn't want an unsqueamish ossifrage, would you?")
+
diff --git a/samples/example-mirrors.txt b/samples/example-mirrors.txt
index c02583e..d511e38 100644
--- a/samples/example-mirrors.txt
+++ b/samples/example-mirrors.txt
@@ -1,4 +1,23 @@
 
+# Example mirror configuration file.
+#
+# Add a "Mirror" command like this for every mirror that you want to list.
+#
+# The "name" is a helpful name of the mirror.
+#
+# The "urlbase" is the top-level of this mirror's copy of the repository.
+# For example, if urlbase is http://foo.bar/baz/, then Thandy will expect
+# to find the keylist at http://foo.bar/baz/meta/keys.txt.
+#
+# The "contents" list should contain a list of file paths patterns for
+# which parts of the repository can be found at this mirror.  For example,
+# if this list is [ "/meta/*", "/pkginfo/tor/**" ], then this mirror
+# keeps up-to-date copies of all files in /meta/, and all files in any
+# subdirectory of "/pkginfo/tor".
+#
+# The "weight" field is an INTEGER representing the relative weight with which
+# we should pick this mirror.
+
 Mirror(name="moria",
        urlbase="http://moria.seul.org/thandy-example/",
        contents=[ "**" ],
diff --git a/samples/example-package.cfg b/samples/example-package.cfg
index 527211b..7f776cf 100644
--- a/samples/example-package.cfg
+++ b/samples/example-package.cfg
@@ -10,9 +10,9 @@ version = [0, 1, 2]
 format = "rpm"
 
 # Where in the repository does it go?
-location = "/pkginfo/example/rpm/example.txt"
+location = "/pkginfo/example/rpm/example-0.1.2.txt"
 
-# Where in the repository does its underlying rpm file go?
+# Where in the repository does its underlying rpm or exe (etc) file go?
 relpath = "/data/example-0.1.2.rpm"
 
 # Decriptions of the package.
diff --git a/samples/testpackage.cfg b/samples/testpackage.cfg
deleted file mode 100644
index 8b13789..0000000
--- a/samples/testpackage.cfg
+++ /dev/null
@@ -1 +0,0 @@
-