vbatts/path-packer-c
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
James Bowes 2012-08-13 13:00:50 -03:00
parent 6c00822523
commit b733d69aa4
1 changed files with 45 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -1,41 +1,65 @@
Overview Overview
======== ========
POC to compile a data set into a modified radix tree, A POC to take a list of content sets (basically a listing of directories) and
and applying huffman encoding. pack them into a format optimized for space efficieny and reading.
Compilation and Usage
=====================
Usage This repo holds two commands, `thing.rb` (TODO: give it a better name) and
===== `unpack`. `thing.rb` is used to pack content sets into our custom data format.
`unpack` reads the format.
Take in an v1 x509 certificate, and extract the To compile the `unpack` command, just run `make`.
content sets, output them to newline delimited output This requires make, gcc, and zlib-devel.
`$> ruby ./thing.rb d this-cert.pem` thing.rb
--------
This would produce a file named 'this-cert.txt' `thing.rb` generates files in our packed data format from newline delimited
lists of content sets. It can also dump content sets from a hosted v1
entitlement certificate, and print the tree structure of the content sets.
Take in an v1 x509 certificate, and extract the content sets, output them to
newline delimited output
`./thing.rb d this-cert.pem`
This would produce a file named `this-cert.txt`
To see this txt list, in the tree format, do: To see this txt list, in the tree format, do:
`$> ruby ./thing.rb p this-cert.txt | less` `./thing.rb p this-cert.txt | less`
Process this output to generate the compiled dictionary output Process this output to generate the packed data format:
`$> ruby ./thing.rb c this-cert.txt` `./thing.rb c this-cert.txt`
This would produce a file named 'this-cert.bin' This would produce a file named `this-cert.bin`. The `c` command expects as
Then, the unpack the binary with: input a file containing a newline delimited list of content sets; you are free
to manipulate the output from a pem file or come up with your own crazy listing
to push the boundaries of the data format.
`$> ./unpack this-cert.bin` `thing.rb` supports a "-v" verbose flag to print debug information.
or
`$> ruby ./unpack.rb this-cert.bin`
unpack
------
The 'thing.rb' supports a "-v" verbose flag. `unpack` can read and examine files in our data format.
Code compiles To view stats on a packed file (size of dictionary, number of unique nodes,
============= etc):
To compile the 'unpack' command, just run `make`. `./unpack s this-cert.bin`
( this requires make, gcc, and zlib-devel)
To reconstruct the content sets and dump them to stdout:
`./unpack d this-cert.bin`
To check if the path `/content/rhel/6/6Server/x86_64/os/repodata/repomd.xml`
matches a content set in `this-cert.bin`:
`./unpack c this-cert.bin /content/rhel/6/6Server/x86_64/os/repodata/repomd.xml`
There is also a WIP ruby version of unpack, unpack.rb