On Fri, 2001-10-05 at 02:30, Jaroslav Kysela wrote:
> On 4 Oct 2001, Josh Green wrote:
> 
> Me, unfortunately, as being maintainer for many things around, I'm always
> busy. I take almost all recomendations, but I've not found a while to
> prepare some documentation generator scripts on the server.
> 

I wrote a simple little script just now for this task. Not sure if it
will be any help or not, but I've attached it. I would be willing to
help out with the web server if you want, although the web isn't really
my specialty. Its really about getting the information out there
anyways, looks being a secondary objective (I do like the way the ALSA
homepage looks though).

> > many people willing to keep it up to date with current developement. It
> > would be kind of nice to have a general time line of whats planned
> > before next official release of 1.0, etc. Something to get the public
> 
> Let's discuss about it. We can prepare a roadmap on this list and I'll
> publish it on the web server.
> 
> Items to start:
> 
> 0.9.0 final
>       - more verbose cross-reference documentation with examples
>           to allow audio developers easy port their applications
>       - add proper power management code to lowlevel drivers
>       - fix bugs

Bugs?? What bugs?? :)

> 
> 1.0
>       - finish sequencer side (instrument handling API)
>               - InterWave and SoundFont formats
> 

Time permitting, I would like to help with the SoundFont side of things.
I'm writing a libsoundfont library that will have a database like API
for streaming SoundFont changes. To add, update, delete and query items
in a sound font. If I finish this library any time soon, it might be of
use to ALSA (not to use directly, but to borrow code from, of course).

> 
> Well, the API is almost stable. In last months only minor things are added
> which don't affect anything else. We have all interfaces stable enough,
> there are gaps only in the sequencer API (universal instrument
> management).
> 
>                                               Jaroslav
> 

Its nice to hear that it is almost stable :) I also like that list of
things to do (fairly short) and that it includes SoundFont patches too.
If I have any more ideas about web site stuff for ALSA, I'll just
impliment it, show it to you and then you can do what you want with it.
Maybe a CVS repository for the web site? Perhaps thats going too far.

-- 
    Josh Green
    Smurf Sound Font Editor (http://smurf.sourceforge.net)
#!/bin/sh

# auto update of ALSA lib CVS doxygen documentation
# *** Note: All files in WEBDOC_DIR and alsa-cvs/alsa-lib are erased! ***
# This simple script written by Josh Green <[EMAIL PROTECTED]>
# Copyright: Yeah right.. :) Oct 5, 2001

SOURCE_DIR=/home/josh/tmp/alsa-cvs
WEBDOC_DIR=/home/josh/web/alsa/cvsdocs

# command to run in alsa-lib/doc directory to generate docs
DOX_CMD="/usr/bin/doxygen doxygen.cfg"

# Paths to commands

CVS=/usr/bin/cvs
MAKE=/usr/bin/make


# Start doing stuff

cd ${SOURCE_DIR}

if [ $? != 0 ]; then
    echo "Error changing to alsa-lib in source directory"
    exit 1
fi


rm -rf alsa-lib

$CVS -z3 -d ':pserver:[EMAIL PROTECTED]:/cvsroot/alsa' -Q\
  co -P alsa-lib >/dev/null

if [ $? != 0 ]; then
    echo "Error updating alsa-lib CVS source"
    exit 1
fi


cd alsa-lib/doc && ${DOX_CMD} >/dev/null

if [ $? != 0 ]; then
    echo "Error making alsa-lib documentation"
    exit 1
fi

if [ ! -r doxygen/html/index.html ] ; then
    echo "Error documentation not created or permission denied"
    exit 1
fi


rm -f ${WEBDOC_DIR}/*

mv doxygen/html/* ${WEBDOC_DIR}

if [ $? != 0 ]; then
    echo 'Error moving documentation to web directory!'
    exit 1
fi

Reply via email to