1 jim.wunderlich 1.1 Compressed Repository readme
2 ============================
3
4 Filename: readme.compressed_repository
5 Authors: Karl Schopmeyer, Jim Wunderlich,
6 Date: 28 Feb. 2005
7
8 PEP 214 added the capability added the capability to utilize
9 compression algorithms on the repository. The compressed repository
10 is approximately 70% smaller than a regular xml text based repository.
11 This allows significant disk space savings a also results in shorter
12 file load times.
13
14 The compression logic is installed as a conditionally compiled option.
15 To enable the compressed repository functionality:
16 1. Install zlib
17 2. define PEGASUS_ENABLE_COMPRESSED_REPOSITORY=true in the environment
18 3. build Pegasus.
19
20 LIBZ INSTALLATION:
21 ------------------
22 jim.wunderlich 1.1
23 libz is used in the compression logic so it must be installed in
24 a standard location prior to enabling the compressed repository
25 functionality.
26
27 LIBZ web pages are:
28
29 http://www.sourceforge.net
30 http://gnuwin32.sourceforge.net/packages/zlib.htm
31 http://www.winimage.com/zLibDll/
32 http://www.gzip.org/zlib/
33
34 LIBZ INSTALLATION ON WINDOWS PLATFORMS:
35 --------------------------------------
36 The standard libz install is:
37 "Program Files"\GnuWin32\include
38 zlib.h and zconf.h
39 "Program Files"\GnuWin32\lib
40 libz.a
41 "Program Files"\GnuWin32\bin
42 zlib1.dll
43 jim.wunderlich 1.1
44 These are the locations used by the windows libz package
45 available on www.sourceforge.net specifically at
46 http://gnuwin32.sourceforge.net/packages/zlib.htm.
47
48 The make file specifies these GnuWin32 directories (include and lib)
49 for the compilation of the CIMRepository. The CIMserver.exe will use
50 the zlib1.dll and expects to find it in one of the search path directories.
51
52 The directory containing the zlib1.dll library must be in the search path.
53 You may include the Gnuwin/bin directory in your search path or
54 alternatively you may move zlib1.dll to another directory that is already
55 in your search path.
56
57
58 LIBZ INSTALLATION ON UNIX PLATFORMS:
59 ------------------------------------
60 Install zlib.h & zconf.h in the standard system includes directory.
61 Install libz.a in the standard systems library directory.
62 Install zlib1.dll in the standard executables directory
63
64 jim.wunderlich 1.1
65 COMPILATION:
66 ------------
67
68 To enable the compressed repository functionality
69 define PEGASUS_ENABLE_COMPRESSED_REPOSITORY in the environment,
70 prior to building the tree. Then build the whole source tree.
71
72 set PEGASUS_ENABLE_COMPRESSED_REPOSITORY=on
73 export PEGASUS_ENABLE_COMPRESSED_REPOSITORY=on
74 etc.
75
76 USAGE:
77 -----
78
79 With the compression code enabled and compiled:
80 - All repositories built will be in the compressed format by default.
81 - all repository formats can be read.
82 - all repository formats can be written.
83 To build a non compressed repository with compression enabled:
84 set PEGASUS_COMPRESS_REPSOITORY to "build_non_compresed".
85 jim.wunderlich 1.1 This is used by the CompareXmlCompressed repository test.
86
87 export PEGASUS_ENABLE_COMPRESSED_REPOSITORY=on
88 export PEGASUS_ENABLE_COMPRESSED_REPOSITORY=build_non_compressed
89 set PEGASUS_ENABLE_COMPRESSED_REPOSITORY=on
90 set PEGASUS_ENABLE_COMPRESSED_REPOSITORY=build_non_compressed
91
92 TESTERS NOTE:
93 ------------
94
95 If PEGASUS_ENABLE_COMPRESSED_REPOSITORY is defined then the CompareXmlCompressed
96 test is run. If it is not defined then the CompareXmlCompressed is not run.
97
98 However if you have the zlibs installed and want to normally test
99 everything with a regular repository but want to run the
100 CompareXmlCompressed test then define PEGASUS_ENABLE_COMPRESSED_REPOSITORY_TEST.
101 This will cause the test to run, it will recompile the CIMRepository for
102 compression, run the test and then recompile CIMRepository for
103 non-compression.
104
|