Re: [Scrollkeeper-devel] Packing scrollkeeper

[Dan M. <mu...@al...>]

On Tue, 16 Jul 2002, Brian Cameron wrote:

> Scrollkeeper experts:
> 
> I am currently working to make sure that Sun's shipment of
> scrollkeeper is correct.  I have a few questions that I need
> cleared up.
> 
> 1. I notice that scrollkeeper seems to have very similar files in
>    the following directories:
>    
>    share/scrollkeeper/Templates
>    var/lib/scrollkeeper
>    
>    Do we have to ship all the files in both directories?

The original data files are installed into the Templates path.  Whenever a 
new database is generated (ie. at first install time, or if the old 
database somehow gets corrupted and the admin decides to regenerate it) 
the files in Templates are copied into /var/... to initialize the database 
before any documents are registered.  

Note that the files under /var are variable (ie. they are generated and/or 
editted by running programs) while the other files installed by a package 
(eg. under /share or /usr/share or /bin ) are binaries or data files which 
should not be modified by running programs.

So, the short answer is that you should only install the files in 
Templates, and ScrollKeeper will generate the files under /var at the end 
of the installation process.

> 2. Sun packaging requires that the pkgmap specifies which files are
>    editable.  I understand some files that scrollkeeper installs can
>    be modified when future packages are installed.  Specifically
>    which files are installed?

None of the ScrollKeeper files (installed or generated) are intended to be 
modified by other packages.  Only /etc/scrollkeeper.conf should be editted 
by hand by an admin.  Scrollkeeper itself generates and modifies the files 
under /var, which is the database (/var/lib/scrollkeeper) along with the 
log files (/var/log/scrollkeeper*).  None of the files under /var get 
installed.  They are all generated by ScrollKeeper the first time it runs 
and then editted each time it runs.

> 3. Scrollkeeper ships with a bunch of executables in /bin.  Which of 
>    these need to be installed on an end-user system (because an
>    end-user would need to run them, or they get run in preinstall
>    or postinstall scripts).  
>    
> 4. Which /bin executables would only be used by a developer?  Which
>    ones only by a system administrator, and which (if any) by an end
>    user?  Would it make sense for programs run only by sysadmins
>    (like in preinstall & postinstall scripts) to be moved to /sbin?
>    
> For reference, here is a list of everything scrollkeeper ships in /bin:
> 

developers and anybody building a package from source:
>   /bin/scrollkeeper-preinstall

developers only:
>   /bin/scrollkeeper-gen-seriesid
>   /bin/scrollkeeper-extract

admins and end-users (ie. it may used when installing and uninstalling 
packages, so everybody needs these):
>   /bin/scrollkeeper-update
>   /bin/scrollkeeper-install
>   /bin/scrollkeeper-uninstall
>   /bin/scrollkeeper-rebuilddb

Users.  This is run by various other binaries to identify the location  
other ScrollKeeper files were installed.
>   /bin/scrollkeeper-config

Users.  These are run by a help browser to access the data:
>   /bin/scrollkeeper-get-cl
>   /bin/scrollkeeper-get-content-list
>   /bin/scrollkeeper-get-toc-from-id
>   /bin/scrollkeeper-get-toc-from-docpath
>   /bin/scrollkeeper-get-index-from-docpath
>   /bin/scrollkeeper-get-extended-content-list

I'm not sure which ones really belong in /sbin, if any.  Perhaps the 4 
starting with scrollkeeper-update and none of the others.

I hope this helps.

-Dan