[livesupport-dev] development environment, conventions - Airtime Development Discussions on Sourcefabric Forum

import

I came up with the first iteration of the development environment. the
directory structure is explained here:
http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/directoryStructure.html
and the build environment for each component is described here:
http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/buildEnvironment.html

you can traverse the directory strucutre by starting at
http://tyrell.hu/~darkeye/livesupport/

to have some content already in there, you will find the currently
existing model documentation and the above two documents in the doc
directory. for tools, you'll see CppUnit, a C++ unit testing framework.
I also wrote a Hello, World! style module sample and a similarly simple
application.

it would be nice to aggree on the file format convetions. please see the
following as examples for different types of files:

shell script:
http://tyrell.hu/~darkeye/livesupport/modules/hello/bin/autogen.txt

makefile template:
http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/Makefile.in

autoconf file template:
http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/configure.ac

C++ header file:
http://tyrell.hu/~darkeye/livesupport/modules/hello/include/Hello.h

C++ source file:
http://tyrell.hu/~darkeye/livesupport/modules/hello/src/Hello.cxx

you'll see that basically all these text-based source files have a
similar strucutre, e.g.:

GNU GPL and other copyright statements
some information on the file itself (author, version, location in CVS)
then they are segmented visually

if we can aggree on the format of these files, I'll create a coding
convetion document describing them. this will make it easier for others
to collaborate in the project. I also think that such conventions would
be beneficial to the PHP part of the project as well.

BTW, I still don't see a "LiveSupport project page" anywhere, or even a
URL, which we could put into these files as a generic pointer to our
project. Also, it would be nice to have our CVS server set up, so that
all this content could go in there already.

with regards to the development process, I started using doxygen for
generating documentation from the C++ source code. For a _very_ simple
sample, see
http://tyrell.hu/~darkeye/livesupport/modules/hello/doc/doxygen/html/annotated.html

also, we'll be using CppUnit, a C++ Unit testing framework. in the above
example, the Hello module already contains Unit test for both its
functions. CppUnit outputs plain text or XML, the latter looks like:

HelloTest::getSingleton

HelloTest::checkHello

2
0
0
0

with a proper XSL style sheet, we could display these results as an HTML
page in a browser. I wonder if someone who has better XSL skills than me
would want to create such a stylesheet Smile

------------------------------------------
Posted to Phorum via PhorumMail

import

This is a multipart message in MIME format.
--=_alternative 0069CE8AC1256ECE_=
Content-Type: text/plain; charset="us-ascii"

Hi Akos,

Looking forward to drilling down into the development environment. Michal
is working on setting up the LS dev server, and it should be ready in the
very near future.

doug

Akos Maroy
07/11/2004 09:07 PM
Please respond to livesupport-dev

To: livesupport-dev@campware.org
cc:
Subject: [livesupport-dev] development environment, conventions

I came up with the first iteration of the development environment. the
directory structure is explained here:
http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/directoryStructure.html
and the build environment for each component is described here:
http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/buildEnvironment.html

you can traverse the directory strucutre by starting at
http://tyrell.hu/~darkeye/livesupport/

to have some content already in there, you will find the currently
existing model documentation and the above two documents in the doc
directory. for tools, you'll see CppUnit, a C++ unit testing framework.
I also wrote a Hello, World! style module sample and a similarly simple
application.

it would be nice to aggree on the file format convetions. please see the
following as examples for different types of files:

shell script:
http://tyrell.hu/~darkeye/livesupport/modules/hello/bin/autogen.txt

makefile template:
http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/Makefile.in

autoconf file template:
http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/configure.ac

C++ header file:
http://tyrell.hu/~darkeye/livesupport/modules/hello/include/Hello.h

C++ source file:
http://tyrell.hu/~darkeye/livesupport/modules/hello/src/Hello.cxx

you'll see that basically all these text-based source files have a
similar strucutre, e.g.:

GNU GPL and other copyright statements
some information on the file itself (author, version, location in CVS)
then they are segmented visually

if we can aggree on the format of these files, I'll create a coding
convetion document describing them. this will make it easier for others
to collaborate in the project. I also think that such conventions would
be beneficial to the PHP part of the project as well.

BTW, I still don't see a "LiveSupport project page" anywhere, or even a
URL, which we could put into these files as a generic pointer to our
project. Also, it would be nice to have our CVS server set up, so that
all this content could go in there already.

with regards to the development process, I started using doxygen for
generating documentation from the C++ source code. For a _very_ simple
sample, see
http://tyrell.hu/~darkeye/livesupport/modules/hello/doc/doxygen/html/annotated.html

also, we'll be using CppUnit, a C++ Unit testing framework. in the above
example, the Hello module already contains Unit test for both its
functions. CppUnit outputs plain text or XML, the latter looks like:

HelloTest::getSingleton

HelloTest::checkHello

2
0
0
0

with a proper XSL style sheet, we could display these results as an HTML
page in a browser. I wonder if someone who has better XSL skills than me
would want to create such a stylesheet Smile

--=_alternative 0069CE8AC1256ECE_=
Content-Type: text/html; charset="us-ascii"

Hi Akos,

Looking forward to drilling down into the development environment. Michal is working on setting up the LS dev server, and it should be ready in the very near future.

doug

Akos Maroy <darkeye@tyrell.hu>

07/11/2004 09:07 PM

Please respond to livesupport-dev

To: livesupport-dev@campware.org

cc:

Subject: [livesupport-dev] development environment, conventions

I came up with the first iteration of the development environment. the

directory structure is explained here:

http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/directoryStructure.html

and the build environment for each component is described here:

http://tyrell.hu/~darkeye/livesupport/doc/developmentEnvironment/buildEnvironment.html

you can traverse the directory strucutre by starting at

http://tyrell.hu/~darkeye/livesupport/

to have some content already in there, you will find the currently

existing model documentation and the above two documents in the doc

directory. for tools, you'll see CppUnit, a C++ unit testing framework.

I also wrote a Hello, World! style module sample and a similarly simple

application.

it would be nice to aggree on the file format convetions. please see the

following as examples for different types of files:

shell script:

http://tyrell.hu/~darkeye/livesupport/modules/hello/bin/autogen.txt

makefile template:

http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/Makefile.in

autoconf file template:

http://tyrell.hu/~darkeye/livesupport/modules/hello/etc/configure.ac

C++ header file:

http://tyrell.hu/~darkeye/livesupport/modules/hello/include/Hello.h

C++ source file:

http://tyrell.hu/~darkeye/livesupport/modules/hello/src/Hello.cxx

you'll see that basically all these text-based source files have a

similar strucutre, e.g.:

GNU GPL and other copyright statements

some information on the file itself (author, version, location in CVS)

then they are segmented visually

if we can aggree on the format of these files, I'll create a coding

convetion document describing them. this will make it easier for others

to collaborate in the project. I also think that such conventions would

be beneficial to the PHP part of the project as well.

BTW, I still don't see a "LiveSupport project page" anywhere, or even a

URL, which we could put into these files as a generic pointer to our

project. Also, it would be nice to have our CVS server set up, so that

all this content could go in there already.

with regards to the development process, I started using doxygen for

generating documentation from the C++ source code. For a _very_ simple

sample, see

http://tyrell.hu/~darkeye/livesupport/modules/hello/doc/doxygen/html/annotated.html

also, we'll be using CppUnit, a C++ Unit testing framework. in the above

example, the Hello module already contains Unit test for both its

functions. CppUnit outputs plain text or XML, the latter looks like:

<?xml version="1.0" encoding='ISO-8859-1' standalone='yes' ?>

<TestRun>

<FailedTests></FailedTests>

<SuccessfulTests>

<Test id="1">

<Name>HelloTest::getSingleton</Name>

</Test>

<Test id="2">

<Name>HelloTest::checkHello</Name>

</Test>

</SuccessfulTests>

<Statistics>

<Tests>2</Tests>

<FailuresTotal>0</FailuresTotal>

<Errors>0</Errors>

<Failures>0</Failures>

</Statistics>

</TestRun>

with a proper XSL style sheet, we could display these results as an HTML

page in a browser. I wonder if someone who has better XSL skills than me

would want to create such a stylesheet Smile

--=_alternative 0069CE8AC1256ECE_=--

------------------------------------------
Posted to Phorum via PhorumMail

import

Reading through your description, I can only agree with this because of lack
of alternative proposal.

On meeting with Tomas next times we should crate an simple structure for
those parts written in PHP.

Sebastian

------------------------------------------
Posted to Phorum via PhorumMail

import

Hi Akos,

Yes, we know that the bitmaps are missing and are a crucial component for
you to begin building the GUI. We just wanted to get an idea of whether or
not the language and structure of the documentation was clear.

We are going to break apart the entire interface and create bitmaps that can
be linked to from each section of the documentation.

Thanks for your feedback.

Regards,
Sangita

----- Original Message -----
From: "Akos Maroy"
To:
Sent: Thursday, October 28, 2004 4:37 AM
Subject: Re: [livesupport-dev] style guide document

> Dear Charles,
>
> I looked at the document, and it seemed very thorough to me. I think
> this level of detail is sufficient to create GUIs. What I find missing
> is the specific bitmaps that would need to be used to create the GUIs
> described in the document, but I guess that would come as some sort of
> attachments.
>
>
> Akos
>

------------------------------------------
Posted to Phorum via PhorumMail

import

Sangita,

> Yes, we know that the bitmaps are missing and are a crucial component for
> you to begin building the GUI. We just wanted to get an idea of whether or
> not the language and structure of the documentation was clear.
>
> We are going to break apart the entire interface and create bitmaps that can
> be linked to from each section of the documentation.

This would be nice to have, at least some part of it, so we can start to
work on the GUI.

Akos

------------------------------------------
Posted to Phorum via PhorumMail

Howdy, Stranger!

Categories

Poll

Top Posters