X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=README;h=944d378a5a1c664c063d577c7d0b77e811f7c11b;hb=c283f067d330a9288aec5510836cd4a898dd07df;hp=23f177f6626f2dc5fd7465e96fb7303fbe5566b8;hpb=0c5b3942a8740e47d44f99ef37795ef52480c706;p=osl.git diff --git a/README b/README index 23f177f..944d378 100644 --- a/README +++ b/README @@ -6,32 +6,35 @@ system provides. Libosl is simple: - - For libosl, all data stored in the osl tables are blobs, - libosl will never try to interpret the table contents. +- For libosl, all data stored in the osl tables are blobs, +libosl will never try to interpret the table contents. - - There is no fancy query language but only a relatively - simple C-API. +- There is no fancy query language but only a relatively +simple C-API. - - There's no support for network-access and libosl does not - use any table locking. +- There's no support for network-access and libosl only uses a very +rudimentary table locking mechanism. + +- There are no dependencies on external libraries. An augmented +version of the red-black tree implementation of the linux +kernel is in included in the libosl package. Libosl is fast: - - It uses sha1 hashes for content-based addressing. +- It uses sha1 hashes for content-based addressing. - - An augmented version of the rbtree implementation of the - linux kernel is used for lookups. +- Red-black trees are used to make lookups fast. Libosl is portable: - - It is known to compile and run on Linux, MacOS, FreeBSD, - NetBSD and Solaris. +- It is known to compile and run on Linux, FreeBSD, NetBSD. It might +work on other Unix systems as well. - - Content and metadata is stored in an endian-agnostic way. +- Content and metadata is stored in an endian-agnostic way. Libosl is open source: - - Licensed under the GPL, version 2. +- Licensed under the GPL, version 2. Apart from the library itself, the package also contains simple examples and an fsck program, oslfsck, which can be used to recover