Login | Register
My pages Projects Community openCollabNet

Frequently asked questions for carnarvon

List of all questions

Introduction

Quickstart, install and use

OS Specific

Project-related questions

Introduction

This FAQ is provided with the hopes of being helpful for users using carnarvon for their projects.

It is a collection of tips and tricks from either the carnarvon users' mailing lists (click here to see the available lists) or other sources of information. It is not a complete overview but it does reflect the interests and problems that the users have expressed somehow. There are also some questions and answers that are not related to the use of carnarvon but to the carnarvon project. They are listed here.

The information is updated as the questions and answers are posted on the mailing list. A certain version of the FAQ is only loosely connected to a specific version of carnarvon but can show how a problem is solved differently in the different versions. The latest version of carnarvon can be found here.

What is carnarvon?
Carnarvon is a software archaeology analysis tool that collects data from pre-existent projects and produce analytical information that can help to understand the evolution of the project through different perspectives. The only requisite for the project to be analyzed is that it has to have its source code under version control software like CVS and Subversion.

Carnarvon is made available under the GPL version 2 or later Open Source License.

Carnarvon latest release is still a beta release.

Where does the name carnarvon come from?
The name carnarvon comes from Lord Carnarvon who was "an English aristocrat best known as the financier of the excavation of the Egyptian New Kingdom Pharaoh Tutankhamun's tomb in Egypt's Valley of the Kings" (see wikipedia)
How can I help?
There are lots of ways

Level 1:

  • Use it!
  • Talk about it!
  • Test it!
  • Find bugs!
  • Report bugs!
  • Verify resolved issues!

Level 2:

  • Help in pin-pointing and fixing bugs!
  • Discuss what you want to work on on the developers mailing list.
  • Fix bugs from Issuezilla yourself and get them committed!
  • Make enhancements yourself and get them committed!
  • Become a developer of carnarvon!
Is there a manual?
Yes. Look Here.
Where do I get the source code for carnarvon?
You can download the source from the same server that you download the application from.

There is an archive with all the source so you can look at it.

Quickstart, install and use

How do I install carnarvon?
Run setup.py script (if necessary as root): python setup.py install If you need a different style of installation, you can find more information in Quick Guide .
Where can I discuss carnarvon usage with other users?
A Users' mailing list is available on the carnarvon site. See the list home page .
Can I use carnarvon for "large" projects?
Yes. The larger the project, the longer it will take to dawonload and perform the analysis.

OS Specific

OS X 10.4: How can I get carnarvon to work?
Carnarvon will work out-of-the-box on MacOSX 10.4 for people who have the Apple Developer Tools installed, because those tools install Python 2.3.5.

Project-related questions

Where and how do I report bugs?
You report bugs by entering them into Issuezilla. Bugs are called defects. Issuezilla also contains feature and enhancement requests.

How you do this is explained on the How to Report Bugs and register enhancements page.

You don't need to ask on any mailing list if it is a problem, if it is already known, or if it is has a solution. If you are having problems, assume that there really is a problem! If you are wrong and it is not really a problem, you will get notified by someone that resolves the issue (as INVALID, WORKSFORME, or FIXED). If you can't find it in Issuezilla, assume that no-one else has reported it! If the bug was already known and reported but you didn't find it, you will get notified by someone that resolves the issue (as DUPLICATE). It might be that it is filed under a completely different problem description since the same problem might manifest itself in different ways.

What information is interesting when reporting a Bug?
Get a screen capture of it and a .txt copy of the stack output for analysis.

Also include what version of carnarvon you are running and on what platform. Useful information includes:

  • OS - Which OS, which version, and which patches
  • Python-version -
  • Hardware - Processor and processor speed, Memory, Hard Drive space, and free hard drive space
It is also helpful if you can tell us the url of the repository where the project being analyzed can be reachable.

How do I suggest an enhancement?
You proceed exactly as when reporting the bug including a search to see if someone else has already suggested that.

How you do this is explained on the How to Report Bugs and register enhancements page.

Something is happening when I run carnarvon that's hard to describe. How should I send a picture or document describing it?
It is probably a bug. Write a defect report and attach your picture or document as part of a defect report. Reporting bugs is described earlier in the FAQ.

If you have successfully reported the problem in Issuezilla there is no need to send an email about it. The discussion and investigation will take place in that issue in Issuezilla.

How do I indicate that I think an enhancement or fix is important?
You vote for the issue.
  • Register for a user id on Tigris.
  • Apply for a role in the carnarvon project. (Observer role is the only one you can apply for).
  • Get the role granted.
  • Login to the Tigris site
  • Find the issue that you are interested in
  • Click on the Vote for this issue link directly above the Additional Comments field
After having voted for an issue you will receive mails when something happens to the issue. This is unless you have turned it off in your Issuezilla settings.

Your votes helps the developers of carnarvon to know what defects are the most important to solve and what features are the most important to add.

How do I see how many votes have been cast for an enhancement or fix?
You can query for all issues that have at least one vote by entering "1" in the At least ____ votes field and clicking on the Submit query button. You will get a list of all issues that have at least one vote cast for them. By following the link to the issue, you can adjust your votes as you see fit.

Another way is to change the columns shown by Issuezilla list to include the Votes column.

This FAQ is maintained by Carlos Gonzalez. Questions about the FAQ should be addressed to karlhangas@tigris.org.
This FAQ was last updated $Date: 2006/06/27 18:15:00 $.
Carlos Gonzalez borrowed the style and some paragraphs for this FAQ from the ArgoUML FAQ page.