Celestia CVS Repository

[don]

Is there any way to search the Celestia CVS Repository at SourceForge?

If not, is there an easy way to get a complete set of the source files for use in searching?

Thank you.

-Don G.

[don]

Ooooookay, how about this ...

Could one of the folks who maintains a copy of the CVS code on their system create a zip file and post it somewhere or e-mail it to me? I just need the full set of files to start with. From there, I can manually update any individual file I might need at the time.

And no, I prefer not to get involved with a CVS client package right now. I would rather focus on Celestia.

If you want to e-mail this zip (or tar) file to me, please send a PM and I will reply with my e-mail address.

Thanks a bunch!

-Don G.

[Paolo]

Hi Don

You can find a zip file with the latest source code at the the following address.
http://members.xoom.virgilio.it/pangeli70/Downloads.htm

But I want to discourage you from manually update the CVS tree.

I'm using wincvs : http://www.wincvs.org/
It is not very complex to install and run and is extremely useful.

Bye - Paolo

[don]

Hi Paolo,

Thank you very much!

I'm using wincvs : http://www.wincvs.org/
It is not very complex to install and run and is extremely useful.

I noticed there were 3 different choices for Windows. Is this one the best of the three (easiest to install, learn, use)? Or would one of the other ones be better?

If other Windows folks are reading this, what are you using?

-Don G.

[chris]

Don,

I'm a WinCVS user . . . It took a bit of fussing to set it up, but nothing too bad. If you plan on doing anything with the Celestia source it's a must.

--Chris

[don]

Hi Chris,

My initial requirement was for global searching, to find out where and how certain variables are being set.

As for actually *doing* anything with the code, I'd love to help out, but I don't think I have the knowledge to do that yet <smile>. I will PM you about this.

-Don G.

[Christophe]

I've set up a LXR cross-reference site:
http://www.teyssier.org/lxr/http/source/

[don]

Christophe,

WOW !!!!!!!!

I love this!!!

Full search capabilities, instant drill-down and cross-linking, WOW!!!

Question: Is this tied to the SourceForge Celestia CVS so it gets updated automatically, or no?

Thank you very much Christophe!

[Christophe]

This is not automatically updated yet, but it's just a matter of adding a small cron job. I'll do that tomorrow.

[Paolo]

Very impressive Christophe

Which program are you using to publish this reference website starting from CVS data?

Bye - Paolo

[don]

Looks like it's a perl script named "genxref" ...

-Don G.

Code: Select all

# $Id: genxref,v 1.5 1998/04/22 12:16:12 pergj Exp $

# genxref.pl --   Finds identifiers in a set of C files using an
#      extremely fuzzy algorithm.  It sort of works.
#
#   Arne Georg Gleditsch <argggh@ifi.uio.no>
#   Per Kristian Gjermshus <pergj@ifi.uio.no>
#
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


[Paolo]

I would like to start studying the celestia source code in deep, to being able to make some programming contributes in future.

As result of this study I would like to create some kind of document that describes the hierarchy of C++ classes. For each class I would write a brief description, adding also some comments for the main data members and methods.

So I was asking me if anyone has already prepared something similar, or if someone is interested in helping in this job.

Bye - Paolo

[don]

...As result of this study I would like to create some kind of document that describes the hierarchy of C++ classes. For each class I would write a brief description, adding also some comments for the main data members and methods.

This sounds wonderful Paolo. I'm not sure if there is such a thing, but I don't think so, based on a message I read a while back. I'm sure Chris, Christophe, Fridger, HankR or someone else who knows for sure will tell us.

I don't know OOP (classes, etc.) but sure would like to learn. Maybe a write-up like yours would help me to learn, right here in Celestia <smile>?

-Don G.

[Christophe]

I would like to start studying the celestia source code in deep, to being able to make some programming contributes in future.

As result of this study I would like to create some kind of document that describes the hierarchy of C++ classes. For each class I would write a brief description, adding also some comments for the main data members and methods.

So I was asking me if anyone has already prepared something similar, or if someone is interested in helping in this job.

That's a good idea. As I've already said in the forum, I think the best way to do this is to add the class descriptions to the source and then use Doxygen to generate the documentation.

[Paolo]

That's a good idea. As I've already said in the forum, I think the best way to do this is to add the class descriptions to the source and then use Doxygen to generate the documentation.

As I haven't CVS priviledges I will publish the classes descriptions in my website, and then some of the developers should insert them in the header of the *.h file.

I think it is important to fix a time limit to execute this job. What do you think?

I've tested Doxygen and I found it not very complex. I agree to use this program to generate the documentation

Bye - Paolo

[chris]

I can work on adding class descriptions this weekend. I don't think a time limit is required though--we're all in this for the fun of it, right?

--Chris

[HankR]

Do we really want our developers spending their time doing <shudder> documentation?

I personally would rather have Chris (in particular) working on implementation instead of documentation.

Actually, the Celestia code is reasonably self-documenting, if you know C++. If you don't, you won't be able to make much of a contribution to Celestia development anyway until you learn it.

I'm not saying more documentation wouldn't be useful. I'm just not sure writing it would be the most effective use of our active developers' time.

I think it might be more efficient if some prospective new developer were to write up the documentation as a way to learn the code, and then let the experienced developers review it.

Just my opinion.

- Hank

[Paolo]

Do we really want our developers spending their time doing <shudder> documentation?

I personally would rather have Chris (in particular) working on implementation instead of documentation.

Actually, the Celestia code is reasonably self-documenting, if you know C++. If you don't, you won't be able to make much of a contribution to Celestia development anyway until you learn it.

I'm not saying more documentation wouldn't be useful. I'm just not sure writing it would be the most effective use of our active developers' time.

I think it might be more efficient if some prospective new developer were to write up the documentation as a way to learn the code, and then let the experienced developers review it.

Just my opinion.

- Hank

To HankR

I appreciate very much the interest of Chris in this documentation job. I agree with you, and I prefere that Chris works on the current development tasks too.

But if Chris and other developers are interested perhaps they feel that this class documentation job should be very useful for themselves because actually the project has a reached a considerable size.

Bye - Paolo

[Paolo]

I can work on adding class descriptions this weekend. I don't think a time limit is required though--we're all in this for the fun of it, right?

--Chris

To Chris

Yes right!

I've asked for a time limit because I haven't so much time, so my intention was to not generate large enthusiasms in short times if someone is interested.

As said by HankR, perhaps is better if the datailed job is done as training by aspirant novice Celestia programmers (like me) and then revised by the development team,.

So I would like to use a your brief class descriptions as a trace for my study.

Have you planned to place class descriptions directly in *.h files, or in a separate file (for example expanding the current devguide.txt in CVS tree) ?

Bye - Paolo

[Christophe]

As I haven't CVS priviledges I will publish the classes descriptions in my website, and then some of the developers should insert them in the header of the *.h file. :)

Even if you don't have CVS write access, you can still do all the editing in your CVS repository and then generate a patch with 'cvs diff -u' which you can then send to me.

I think it is important to fix a time limit to execute this job. What do you think?

Since we don't have a release schedule, I don't think that it's that important.

I've tested Doxygen and I found it not very complex. I agree to use this program to generate the documentation

Fine!