Open main menu

CDOT Wiki β

Changes

Code Indexer

2,311 bytes added, 14:19, 16 January 2007
Status
==Project Contributor(s)==
 
==Status==
I now have some time to resume work on the project. This time I will manage my time more wisely
<strike>I have too many assignments. I need to do work on them, but I should have more free time during the Christmas break.</strike>
==Options==
* Help with [http://lxr.mozilla.org/ LXR]/[http://landfill.mozilla.org/mxr-test/ MXR]/[http://www.mozilla.org/bonsai.html Bonsai] development.
* Make a sort-of branch respectful version of [[OpenGrok]]but this would be a very shoddy implementation that doesn't really do what it should* Setup one OpenGrok per active branch of the Mozilla Project, this would have no version history whatsoever, apart from file dates.
* [Re]write major portions of how [[OpenGrok]] deals with history and changesets and the likes, this is my personal preference.
* Try to fit [http://www.cenqua.com/fisheye/index.html Fisheye] into the current development model, but it seems this might be more like finding a problem for a solution. That This is a very very powerful tool, but it is not really like LXR or OpenGrok, it is more useful to analyze CVS/SVN histories more than search for functions, files, definitions and the likes. Fisheye is also '''extremely''' slow. Within my lan, it takes a long time to do any queries, and over the internet it is impossible. I don't know why, especially since OpenGrok uses the same basic technologies. (10 minutes plus for one page load on a lan connection, in its defence, it is still indexing the code) ====Why I like OpenGrok====Apart from the fact that it does not support branches, this is in my opinion the perfect tool. It is fast, open souce and most importantly, it makes really easy to navigate, well thought out pages that just work. Because of the way OpenSolaris does file versions for their code, they don't use branches at all. OpenSolaris currently uses a linear method of file versioning, they don't use branches, they use versions as a sory of branch, basically the idea that Office 12 is the "2007 branch" and Office 11 is the "2003 branch". Mozilla doesn't do this, so it would be nessecary to say implement this feature. Luckily, however, OpenGrok is very modularized and atomic in nature. If you go to the OpenGrok page, you can get a more complete explanation, but the basic jist of it is that there are many "Guru's", each with a task. The files are first read by the History Guru who looks at the file and decides what type of versioning the file uses. Once the versions have been analyzed, they are passed on to the file analyzer guru who then decides what type of file it is , and passes it on to a file type analyzer. The allows for portions of the code to be changed without changing the whole system, so if we wanted to be able to do special things with XUL/XPCOM as far as how to handle its symbols, we would write one module which is not dependent at all on any other file analyzer. The same way, if Mozilla switchs to SVN, we would just port the branching support to SVN. On the chances that Mozilla switches to something other than CVS or SVN, a HistoryGuru could be written for that type of versioning history. The OpenGrok project is under the [http://www.sun.com/cddl/ CDDL] which [http://www.sun.com/cddl/CDDL_MPL_redline.pdf derives from the MPL 1.1] In closing, I really like the OpenGrok project because it is '''very good tool''' fast, '''very''' powerful and '''VERY''' modular!
==Links==
* [http://www.mozilla.org/docs/jargon.html Mozilla Jargon]
* [http://www.deitel.com/CodeSearchEngines/CodeSearchEngines_ResourceCenter_MerobaseOpenGrokCodeProject.html Misc]
* [http://www.sun.com/cddl/CDDL_why_details.html CDDL] - explanation of the diferences between the MPL and CDDL
==Pulling CVS==
This code will pull the CVS for the branches specified in @branches, or it did at some point, your mileage may vary
<pre>
#!/usr/bin/perl
# Pull CVS from the mozilla project server
# Where you want the branch folders
my $src_root = "/var/mozilla";
 
# Where you want to you the HTML for the branch info
# This could be SSI'd, but that is a lot of work to set
# up with the ubuntu packages
my $branchlistpath = "${src_root}/branches.html";
# Where is your run.sh for opengrok? (or equivalent script to start the indexer)
# Open the file or
open BRANCHLIST, ">$branchlistpath" or die "Could not open file";
 
# Number of branches, twice, once for the line, once for the description
my $branchcount = ($#{branches} + 1) * 2;
 
# Print the begining of the select block
print BRANCHLIST "<select class=\"q\" name=\"branch\" size=\"${branchcount}\" value=\"\" onClick=\"document.cookie = document.sbox.branch.selectedIndex;\" />\n";
# Clear out what ever source was there
make -f ${src_root}/${_}/mozilla/client.mk checkout MOZ_CO_PROJECT=all;
");
# This is for an attempt at doing something, it is mostly useless
print BRANCHLIST "\t<optgroup label=\"$descriptions{$_}\" />\n";
print BRANCHLIST "\t<option> $_ </option>\n";
}
 
print BRANCHLIST "</select>\n";
system ("bash $opengroker");
1
edit