[rucksack-cvs] CVS rucksack

[alemmens]

Update of /project/rucksack/cvsroot/rucksack
In directory clnet:/tmp/cvs-serv2215

Added Files:
	import-export.lisp manual.txt 
Log Message:
Get started with import-export and with a manual.


--- /project/rucksack/cvsroot/rucksack/import-export.lisp	2008/01/23 15:45:03	NONE
+++ /project/rucksack/cvsroot/rucksack/import-export.lisp	2008/01/23 15:45:03	1.1
(in-package :rucksack)

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Import/export
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

;; The contents of a rucksack can be exported to a single file.  The file will
;; contain enough information to reconstruct the original rucksack objects.
;; Rucksack export files use a relatively simple s-expression format.
;;
;; There are two reasons for exporting a rucksack:
;; - backup
;;   The export file has a simple format, so it's a lot less sensitive
;;   to data corruption bugs.
;; - migration
;;   Export files can be imported by newer versions of Rucksack.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Import/export API
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defgeneric export-rucksack (rucksack pathname)
  (:documentation "Export all objects in a rucksack to a file.  The
resulting file can be imported by newer versions of Rucksack."))

(defgeneric import-rucksack (pathname directory-designator
                             &rest args
                             &key (if-exists :error)
                             &allow-other-keys)
  (:documentation "Creates a new rucksack in the directory specified by
DIRECTORY-DESIGNATOR, opens the new rucksack and imports all objects
that were exported to the file specified by PATHNAME."))


--- /project/rucksack/cvsroot/rucksack/manual.txt	2008/01/23 15:45:03	NONE
+++ /project/rucksack/cvsroot/rucksack/manual.txt	2008/01/23 15:45:03	1.1

* Getting started

To compile and load Rucksack and make sure that the basics are working:

1. Make sure you have ASDF (Another System Definition Facility) loaded.

2. Compile and load rucksack.asd.

3. Compile and load tests/rucksack-test.asd.

4. (asdf:oos 'asdf:load-op :rucksack-test :force t)

5. (in-package :rucksack-test)

6. (run-tests)