You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Benjamin Bazso <bb...@cae.com> on 2005/02/22 13:13:28 UTC
Development Documentation
Hello Subversion Developers,
We are a team of guys interested in starting to develop with the Subversion
APIs and we were wondering if there is any documentation describing the API.
We read through the HACKING documentation, read the book and started looking
at the command line client code and we were wondering if there exists
documentation on the code. We looked at the API and stuff and have an idea
of the Subversion functions available, but there does not seem to be any
detailed documentation on how these functions work, what they were created
for or a global picture of how the different functionalities fit together.
I kind of programmers guide or design document for the API.
What I would be looking for is some flow diagrams or logical diagrams for
the Subversion subsystems or at least some example code on how the various
elements in the Subversion API can be used. Does a tutorial exist to get
new developers up-to-speed on the project so that they can start to develop
new functionality?
Another request that we would have is a better explanation of the ctx, baton
and how to setup a client context? There is a one line explanation in the
FAQ on a baton, but there is no explanation of what sort of information is
passed using the baton and why.
Any help on the aforementioned issues would be greatly appreciated.
Looking forward to making our contribution,
CAE Inc.
Benjamin Bazso,
Communications Systems Specialist
Military Aircraft and Avionics Systems
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Development Documentation
Posted by Ben Collins-Sussman <su...@collab.net>.
On Feb 22, 2005, at 7:13 AM, Benjamin Bazso wrote:
>
> What I would be looking for is some flow diagrams or logical diagrams
> for
> the Subversion subsystems or at least some example code on how the
> various
> elements in the Subversion API can be used.
Layered flow diagram in the free book:
http://svnbook.red-bean.com/en/1.1/ch01s04.html
The free book also has an entire chapter just about developing with the
APIs:
http://svnbook.red-bean.com/en/1.1/ch08.html
Code examples are in the source tree too:
http://svn.collab.net/repos/svn/trunk/tools/examples
Beyond that, the public API is meant to be self-documenting, and can
even be compiled into doxygen:
http://svn.collab.net/svn-doxygen/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Development Documentation
Posted by Marcus Rueckert <da...@web.de>.
On 2005-02-22 08:21:52 -0500, Mark Phippard wrote:
> http://svn.collab.net/repos/svn/trunk/doc/programmer/
> http://svn.collab.net/repos/svn/trunk/notes/
maybe mention this too:
http://svn.collab.net/svn-doxygen/
darix
--
irssi - the client of the smart and beautiful people
http://www.irssi.de/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Development Documentation
Posted by Mark Phippard <Ma...@softlanding.com>.
Benjamin Bazso <bb...@cae.com> wrote on 02/22/2005 08:13:28 AM:
> We are a team of guys interested in starting to develop with the
Subversion
> APIs and we were wondering if there is any documentation describing the
API.
> We read through the HACKING documentation, read the book and started
looking
> at the command line client code and we were wondering if there exists
> documentation on the code. We looked at the API and stuff and have an
idea
> of the Subversion functions available, but there does not seem to be any
> detailed documentation on how these functions work, what they were
created
> for or a global picture of how the different functionalities fit
together.
> I kind of programmers guide or design document for the API.
>
> What I would be looking for is some flow diagrams or logical diagrams
for
> the Subversion subsystems or at least some example code on how the
various
> elements in the Subversion API can be used. Does a tutorial exist to
get
> new developers up-to-speed on the project so that they can start to
develop
> new functionality?
>
> Another request that we would have is a better explanation of the ctx,
baton
> and how to setup a client context? There is a one line explanation in
the
> FAQ on a baton, but there is no explanation of what sort of information
is
> passed using the baton and why.
>
> Any help on the aforementioned issues would be greatly appreciated.
>
> Looking forward to making our contribution,
The book (Practical Subversion) has a chapter on programming with
Subversion.
http://www.amazon.com/exec/obidos/ASIN/1590592905/103-5745438-0803006
Otherwise, I think the documentation you are looking for exists in the
header files and in some cases in text files stored in the repository. For
example:
http://svn.collab.net/repos/svn/trunk/doc/programmer/
http://svn.collab.net/repos/svn/trunk/notes/
Mark
_____________________________________________________________________________
Scanned for SoftLanding Systems, Inc. by IBM Email Security Management Services powered by MessageLabs.
_____________________________________________________________________________
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org