On Sun, May 5, 2013 at 12:36 PM, Noufal Ibrahim <[email protected]>wrote:

> I think the documentation (README) is lacking in some respects. I've
> tried to add all the stuff I hit and put in a pull request.
>
> https://github.com/mozilla/dxr/pull/129
>

A few comments:

Step 2 says to run "python setup.py develop".  Step 3 says to set up a
virtualenv first, then to run "python setup.py develop".  This a bit
confusing and anybody who doesn't read ahead isn't going to do this
properly.

Step 4: did running make from the top-level directory not automatically
build trilite for you?

Step 5: we should make it so that hacking the makefile is not required.
Why did you have to do this?
    We should probably put the "LLVM must be exactly version 3.2"
requirement somewhere more prominent, rather than burying it down here.

Step 6 and 7: I'm not clear on what we're doing here.  We should probably
tell people to run "make test" if we want to verify that the tests run.  If
we want to get people up with a demo server to play with, maybe that should
be in a separate section as it isn't really part of "Installing".  Also,
the test_basic directory is rather lean for a demo page now that we have
most of the real tests in the new testing framework.  Is it worth coming up
with a dedicated demo directory?  Or should we just direct people to
configuration.mkd and let them figure it out on their own?

-- 
James
_______________________________________________
dev-static-analysis mailing list
[email protected]
https://lists.mozilla.org/listinfo/dev-static-analysis

Reply via email to