Csound Csound-dev Csound-tekno Search About

[Cs-dev] Adding an opcode entry in the docs

Date2005-02-22 15:51
FromAndres Cabrera
Subject[Cs-dev] Adding an opcode entry in the docs
Hi,
I'm writing the documentation for the csoundav opcodes, and I've
followed the instructions on the readme.txt file, and I think there's
something missing. Do the new files also need to be added to the
makefile as well? If I do this, things seem to work, but I'm not
entirely certain this is the way to go...

Apart from that I think Gab's vectorial opcodes should have their own
section. How can I do this?

Cheers,
Andres




-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-02-22 23:22
Fromsteven yi
SubjectRe: [Cs-dev] Adding an opcode entry in the docs
Hi Andres,

John ffitch changed the makefiles to use dependencies, so that requires 
updating the Makefiles.  After working with this a while, I think I'm 
going to switch it back to compile every time and not track 
dependencies.  The compilation always has to recompile all files anyways 
(no intermediary steps like .o files) so it seems to me more work to 
manage dependencies than managing to recompile or not.  So for now, you 
will need to update the dependencies.

To add your own section, I'd recommend using one of the other sections 
folders (each section is in its own folder, for example, the zak or 
table directories) as a model.  So, for vector opcodes, you might want 
to add a vector directory with a top.xml file within it.  In the 
top.xml, add links to the vector opcode entries that should be in the 
opcodes dir.  Then update manual.xml to add entries for entities for the 
vector section and add the vector section to the PartOverview  in 
manual.xml.

In general, the manual is structured so that all opcode entries are 
listed in either the csound5opcode or opcodes section.  Then, there is 
also the sections, but besides information about that section, they only 
link to opcode entries and do not contain entries in themselves.

Sorry if that's not the clearest explanation; feel free to email me any 
questions as you're working and I'd be more than happy to try to help 
out in any way.

steven


Andres Cabrera wrote:
> Hi,
> I'm writing the documentation for the csoundav opcodes, and I've
> followed the instructions on the readme.txt file, and I think there's
> something missing. Do the new files also need to be added to the
> makefile as well? If I do this, things seem to work, but I'm not
> entirely certain this is the way to go...
> 
> Apart from that I think Gab's vectorial opcodes should have their own
> section. How can I do this?
> 
> Cheers,
> Andres
> 


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-02-23 00:31
FromAndres Cabrera
SubjectRe: [Cs-dev] Adding an opcode entry in the docs
Thanks Steven for the explanation. I'll let you know if I run into troubles.

Cheers,
Andres

steven yi wrote:
> Hi Andres,
> 
> John ffitch changed the makefiles to use dependencies, so that requires 
> updating the Makefiles.  After working with this a while, I think I'm 
> going to switch it back to compile every time and not track 
> dependencies.  The compilation always has to recompile all files anyways 
> (no intermediary steps like .o files) so it seems to me more work to 
> manage dependencies than managing to recompile or not.  So for now, you 
> will need to update the dependencies.
> 
> To add your own section, I'd recommend using one of the other sections 
> folders (each section is in its own folder, for example, the zak or 
> table directories) as a model.  So, for vector opcodes, you might want 
> to add a vector directory with a top.xml file within it.  In the 
> top.xml, add links to the vector opcode entries that should be in the 
> opcodes dir.  Then update manual.xml to add entries for entities for the 
> vector section and add the vector section to the PartOverview  in 
> manual.xml.
> 
> In general, the manual is structured so that all opcode entries are 
> listed in either the csound5opcode or opcodes section.  Then, there is 
> also the sections, but besides information about that section, they only 
> link to opcode entries and do not contain entries in themselves.
> 
> Sorry if that's not the clearest explanation; feel free to email me any 
> questions as you're working and I'd be more than happy to try to help 
> out in any way.
> 
> steven
> 
> 
> Andres Cabrera wrote:
> 
>> Hi,
>> I'm writing the documentation for the csoundav opcodes, and I've
>> followed the instructions on the readme.txt file, and I think there's
>> something missing. Do the new files also need to be added to the
>> makefile as well? If I do this, things seem to work, but I'm not
>> entirely certain this is the way to go...
>>
>> Apart from that I think Gab's vectorial opcodes should have their own
>> section. How can I do this?
>>
>> Cheers,
>> Andres
>>
> 
> 
> -------------------------------------------------------
> SF email is sponsored by - The IT Product Guide
> Read honest & candid reviews on hundreds of IT Products from real users.
> Discover which products truly live up to the hype. Start reading now.
> http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
> 
> 
> 


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net