I have made repeated explanations of the function of this file to the list
and to John. Never has John asked for a clarification of my explanation if
he did not understand it.

============================================
Michael Gogins
gogins at pipeline period com
Irreducible Productions
CsoundVST, an extended version of Csound for programming music and sound
Available at http://sourceforge.net/projects/csound/
============================================


----- Original Message ----- 
From: 
To: "Csound Developers Discussion List" 
Sent: Tuesday, November 18, 2003 6:47 AM
Subject: [CSOUND-DEV:3381] Re: Road to Reentrancy


> >>>>> "Matt" == Matt J Ingalls  writes:
>
>  Matt> i think i have mentioned about 3000 times on this list i have
already done
>  Matt> this! and  i sent the relative code to this list and to john ffitch
it
>  Matt> must be over a year ago now.  I just made the assumption
>
> The changes were to a file called csound.h which I do not maintain and
> do not use.  I could not work out what I was supposed to do with them
> so they have remained on the "todo" heap
>
> ==John ffitch
>

I think what we need now, especially now that Csound is on CVS, is 
formal documentation of csound.h and the API in general (even if still 
subject to change), so that not only those privy to an archive of this 
list, but those who may discover Csound CVS tomorrow, have 
self-contained information. Annotating each function is not enough - we 
need a synopsis of the architecture, design philosopy and a "TODO" list 
too. I have done a quick search for "csound.h" in my stock of posts, and 
find plenty of snippets about this and that (discussions more than 
documentation), so I am in much the same situation as John, and I think 
other people may be too. It would be impossible for me to assemble 
complete and accurate formal documentation on this just from the bits 
and bobs in various posts to the list, any more than I could reconstruct 
the VST SDK from posts to the vst dev list.

This documentation would then itself go into  CVS so that it is 
automatically there with all the other files.

Someone will write a book about all this one day...
:-)


Richard Dobson




Michael Gogins wrote:

> I have made repeated explanations of the function of this file to the list
> and to John. Never has John asked for a clarification of my explanation if
> he did not understand it.
> 

Well, the documentation in csound.h is pretty thorough IMO, and it's
fairly easy to read with doxygen generated documentation.  

However, a developer doc for architecture, design philosophy, and a TODO
list would be very nice to have.  

One thing I would like to bring up again would be moving all source code
into a src folder within the main CVS, so that we can add a doc folder
and keep TODO, LICENSE, etc. in the top level (I believe this is
standard GNU convention for project organization).  I can go ahead and
do this change but it would mean everyone doing pretty much a fresh
checkout to start again with the new locations of files.

steven



On Tue, 2003-11-18 at 08:10, Richard Dobson wrote:
> I think what we need now, especially now that Csound is on CVS, is 
> formal documentation of csound.h and the API in general (even if still 
> subject to change), so that not only those privy to an archive of this 
> list, but those who may discover Csound CVS tomorrow, have 
> self-contained information. Annotating each function is not enough - we 
> need a synopsis of the architecture, design philosopy and a "TODO" list 
> too. I have done a quick search for "csound.h" in my stock of posts, and 
> find plenty of snippets about this and that (discussions more than 
> documentation), so I am in much the same situation as John, and I think 
> other people may be too. It would be impossible for me to assemble 
> complete and accurate formal documentation on this just from the bits 
> and bobs in various posts to the list, any more than I could reconstruct 
> the VST SDK from posts to the vst dev list.
> 
> This documentation would then itself go into  CVS so that it is 
> automatically there with all the other files.
> 
> Someone will write a book about all this one day...
> :-)
> 
> 
> Richard Dobson
> 

ok i need some help with getting to csound.  i already have a
sourceforge account and familiar with cvs, i just cant see
csound5.  do i need to become i member?

john?  my user name is ingalls

thanks,'m

Hi Matt,

If you're just wanting to grab the source, you can login anonymously via 
pserver and do a checkout of the source.  The commands for that at the 
commandline would be:

cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/csound login

(type enter when prompted for password)

then:

cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/csound co csound5

Last I checked it seemed that pserver was up to date with latest cvs (it 
was a day behind for sourceforge projects for a while, but I think it's 
been fixed up). 

When John has a chance to add you as a developer, you won't have do the 
login step, but instead will be prompted for your sourceforge password 
each time you do an operation (unless you generate a key, there's some 
docs on sourceforge about that:

http://sourceforge.net/cvs/?group_id=81968

).  You would checkout sources with:

cvs -d:ext:ingalls@cvs.sourceforge.net:/cvsroot/csound co csound5

Update your sources against the cvs with:

cvs -d:ext:ingalls@cvs.sourceforge.net:/cvsroot/csound update
(have to be within the local csound5 directory, it updates from the 
current directory and down)

Commit a source change as:

cvs -d:ext:ingalls@cvs.sourceforge.net:/cvsroot/csound commit -m "My 
message about what changed with this commit" fileName

And do a diff between what's local and the latest in the head branch with:

cvs -d:ext:ingalls@cvs.sourceforge.net:/cvsroot/csound diff  fileName

You can do other things like get revision history and other things; I 
find that for this it's easier to use a GUI based CVS tool so you can 
check the commit messages and do diffs of different versions.

At the sourceforge URL above there's also a link to browsing the CVS via 
web.  There you can find what top level modules are in the CVS (current 
there's:

csound    - csound4 source tree
csound5   - csound5 source tree
manual   - ACRM

Hope that helps!
steven


Matt J. Ingalls wrote:

>ok i need some help with getting to csound.  i already have a
>sourceforge account and familiar with cvs, i just cant see
>csound5.  do i need to become i member?
>
>john?  my user name is ingalls
>
>thanks,'m
>
>
>
>  
>