[DRE-commits] r2291 - in packages/mahoro/trunk: . debian

[lucas at alioth.debian.org]

Author: lucas
Date: 2007-12-18 13:14:51 +0000 (Tue, 18 Dec 2007)
New Revision: 2291

Added:
   packages/mahoro/trunk/README
Modified:
   packages/mahoro/trunk/debian/changelog
Log:
added a README file with some documentation. prepared for upload

Added: packages/mahoro/trunk/README
===================================================================
--- packages/mahoro/trunk/README	                        (rev 0)
+++ packages/mahoro/trunk/README	2007-12-18 13:14:51 UTC (rev 2291)
@@ -0,0 +1,44 @@
+The following was copied from http://mahoro.rubyforge.org/, as a way to
+provide offline documentation for mahoro (the library isn't documented
+anywhere else).
+
+  Reference
+
+   Mahoro.compile( path )
+
+           path is the path (or colon-separated paths) to a list of
+           non-compiled magic databases. Compiles the files.
+
+   initialize( flags = Mahoro::NONE, path = nil )
+
+           flags may be one or a combination (bitwise or) of the following:
+           NONE, DEBUG, SYMLINK, COMPRESS, DEVICES, MIME, CONTINUE, CHECK,
+           PRESERVE_ATIME, RAW, ERROR. Please refer to magic(3) for more
+           information.
+
+           path may be the path (or colon-separated paths) to a magic
+           database. Leave nil to use the default.
+
+   file( path )
+
+           path is the path to a file. Returns the type of file as a String.
+           To return a mimetype set the flag MIME.
+
+   buffer( input )
+
+           input is a buffer. Works just like file, except reads from input
+           instead.
+
+   flags = flags
+
+           flags is one or a combinatino of the flags specified above.
+
+   valid?( path = nil )
+
+           path is the path (or colon-separated paths) to a magic database.
+           Returns the validity of entries in that database.
+
+   load( path )
+
+           path is the path (or colon-separated paths) to a list of compiled
+           magic databases. Loads the files.

Modified: packages/mahoro/trunk/debian/changelog
===================================================================
--- packages/mahoro/trunk/debian/changelog	2007-12-18 13:07:46 UTC (rev 2290)
+++ packages/mahoro/trunk/debian/changelog	2007-12-18 13:14:51 UTC (rev 2291)
@@ -1,10 +1,11 @@
-mahoro (0.1-4) UNRELEASED; urgency=low
+mahoro (0.1-4) unstable; urgency=low
 
-  * NOT RELEASED YET
   * fixed Vcs-*: point to dir containing debian/, not dir containing
     trunk/
+  * Copied the content from http://mahoro.rubyforge.org/ to the README file,
+    to provide documentation available offline. Closes: #456630.
 
- -- Lucas Nussbaum <lucas at lucas-nussbaum.net>  Wed, 12 Dec 2007 12:30:43 +0100
+ -- Lucas Nussbaum <lucas at lucas-nussbaum.net>  Tue, 18 Dec 2007 14:13:19 +0100
 
 mahoro (0.1-3) unstable; urgency=low