IT/Production Acceptance/DXR: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Moving out non-IT issues to another page)
 
(20 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Project Information==
*'''Project sponsor:''' Taras Glek
*'''Main IT contact:''' Taras Glek
*'''Metrics contact:'''' N/A
*'''Main third party contact:''' David Humphrey
*'''Final application owner/maintainer:'''' Taras Glek
*'''Time Frame:''' ASAP, deployed on a devel server atm.
*'''Site Repository:''' http://hg.mozilla.org/webtools/dxr/
*'''Demo Site:''' http://australia.proximity.on.ca/dxr/
*'''Production Site:''' https://dxr.mozilla.org
*'''DXR Future Work Plan:''' [[DXR Future Work Plan]]
*'''Any pre-requisites needed (technology, server capacity, staffing, monitoring, response time, etc)''': Machine is expected to compile Mozilla continuously in order to produce the index, so should have 8gb ram, quadcore cpu.
*'''External dependencies''': None
*'''Dev environment specs''': No clue what goes here
*'''Does this project use any plugins or proprietary technology:''' No, it's pure awesome.
==What is DXR?==
==What is DXR?==


Line 7: Line 24:
DXR was written and is being actively developed by David Humphrey.
DXR was written and is being actively developed by David Humphrey.


==Bugs==
Bugs can be filed using Mozilla's Bugzilla with [https://bugzilla.mozilla.org/buglist.cgi?quicksearch=product%3Awebtools+component%3Adxr Product:WebTools and Component:DXR]
 
== Mozilla Roll-out Task List ==


* Add DXR bugzilla component - [https://bugzilla.mozilla.org/show_bug.cgi?id=517550 bug 517550]
* DXR Tracking bug - [https://bugzilla.mozilla.org/show_bug.cgi?id=489834 bug 489834]
* Deploy DXR at Mozilla - [https://bugzilla.mozilla.org/show_bug.cgi?id=524725 bug 524725]
* Deploy DXR at Mozilla - [https://bugzilla.mozilla.org/show_bug.cgi?id=524725 bug 524725]
 
* Dave to update DXR hg repo with latest callgraph code
== Task List ==
* Tweak installation and indexing system for use by Mozilla
 
 
* <strike>Start doing continuous re-indexing of the tree</strike> Basic code in place, need to evolve and deploy
* Get DXR deployed on a Mozilla server (bug [https://bugzilla.mozilla.org/show_bug.cgi?id=524725 524725])
* <strike>Switch to using http get for searches</strike> Completed.
* Show Classname:: as part of member sidebar on the right (for searches)
* Switch python web cgi to use django
* Make search results clickable anywhere vs. just on line number and make line number plain text vs. link.
* When searching of nsFoo, display a little summary of the class bases,derived, members
* Remove side bar from searches, and copy Google Code search results by showing other queries at top of results (Narrow your search: 53 Types, 74 Members, ...)
* In decl/def search results (e.g., member) only show line number once.
* Add counts to all search results (glimpse and otherwise)
* Make source code nav bar narrow if contents are narrower, and expand to a max size (current size).
* Fix C++ snippets in IDL to use cpp position indicators (# line file)
* Look for speed-ups in how analysis builds are done
* Add links for #include header files
* <strike>Add derived:classname::method query</strike> Completed.
* Add ability to do Users:nsIFrameFrame::GetDocShell
* Make search sidebars links so they can be turned into searches.  For example, members sidebar could be a link that takes you to a member:foo query
* Search UI should encourage using built-in queries, for example, suggesting other keywords (members:) that could be added.
* When navigating to search result in code for a type or member, sync the source code navigation pane accordingly
* Lazily keep source code nav and source view in sync.  Clicking any stmt should highlight/scroll into view/etc the containing member/class
* Make source code nav panel sortable (alpha, file order)
* Make types clickable in source code nav bar, perhaps open the popup to show type info
* Make types in source code nav bar always clickable, and add icon to take you to decl (should be able to jump to header file from cpp)
* Add hrefs to links in source code dom nodes on hover
* Standardize on look and feel of source code nav bar for members and popups, etc (gray, icons, font)
* Tighten-up look of popup box
* Add pagination to search results
* Add base:type search query
 
* Searching for filenames should work for fullnames vs. initial portions (e.g., nsGlobal or nsGlobalWindow vs. nsGlobalWindow.cpp)
* Add support for C source
* Fix pop-up position so it isn't off the screen
* Fix Users query so it includes uses of the type directly in addition to uses of derived types (e.g., nsIFoo might have direct users if not an idl type)
* Change sort order of members in sidebar panel so it is alphabetical
* Tokenize macros so that embedded macros are clickable (e.g., NS_ProcessNextEvent resolves to NS_ProcessNextEvent_P)
* Investigate ways to deal with naming collisions.  For example, where types, methods, or macros share the same name, sometimes we pick the wrong one for purposes of linkifying (e.g., NS_ProcessNextEvent). 
* Make IDL pages, and other decl locations do a better job at providing links
* Add more query options to search page (e.g., looking for implementations)
* Add support for JS source
* Finish xpidl_xref so all parts of XPIDL are parsed (eg. c++ fragments, typedefs)
* Add Macro decl locations
* Add support for Obj-C/C++ source
* Integrate callgraph: convert to using treehydra, investigate --with-static-checking in mozilla's build sys, include dwitte's callgraph.js and my dxr.js (include "callgraph.js").
* Add Callees and Callers searches to all popups keyed on loc
* Add info to popups that indicates that empty popups are bugs in data/dxr or TODOs (maybe with link to this wiki page or bug filing info).
* Show compiler warnings
* <strike>Improve post-processing speed, investigate better parallelism</strike> Completed.
* Investigate strategy for increment re-indexing vs. full clobbers
* Audit web app for security
* Fix srcdir vs. objdir links (e.g., PRInt32)
* Collapse Type Info and Bases tabs in popups
* Convert popup to use fewer/no tabs, and dynamic/tree regions to show data like members, bases, etc.
* Limit search nav divs to some lower number (12?) and give a link to see the whole thing.
* Remove .html from source file names (mod_rewrite?)
* Add support for html/xml, perhaps with links to MDC doc pages
* Make dxr scripts path agnostic and more portable (python path stuff)
* Make dxr scripts path agnostic and more portable (python path stuff)
* Fix ctor html linkifying code so Foo::Foo works properly
* Figure out how to deal with code being ifdef'ed out (e.g., debug vs. non-debug build)
* Various fixes to dehydra script
* Multi-platform indexing
* Various front-end fixes (e.g., dojo UI stuff)
* Add gcov support
* Add build dependency map info - "what do I have to remake if I change something in content/html/document/src?"
* Add control mechanism for running dxr continuously.  Maybe web based?  Maybe as part of buildbot with waterfall?
* Make http://dxr.proximity.on.ca/dxr/mozilla-central/xpcom/ds/nsHashtable.h.html#144/Put work

Latest revision as of 15:32, 27 February 2010

Project Information

  • Any pre-requisites needed (technology, server capacity, staffing, monitoring, response time, etc): Machine is expected to compile Mozilla continuously in order to produce the index, so should have 8gb ram, quadcore cpu.
  • External dependencies: None
  • Dev environment specs: No clue what goes here
  • Does this project use any plugins or proprietary technology: No, it's pure awesome.

What is DXR?

DXR is a two things. First, it’s a method for collecting type, member, statement, macro, etc. information about C++, IDL, and soon JavaScript using Mozilla’s static analysis tools (e.g., Dehydra), a hacked build system, and a bunch of scripts. Second, it’s a web-based tool for mapping this information back onto source code, and allowing users to query and look-up this information.

You can read more about it here.

DXR was written and is being actively developed by David Humphrey.

Bugs can be filed using Mozilla's Bugzilla with Product:WebTools and Component:DXR

Mozilla Roll-out Task List

  • Deploy DXR at Mozilla - bug 524725
  • Dave to update DXR hg repo with latest callgraph code
  • Tweak installation and indexing system for use by Mozilla
  • Make dxr scripts path agnostic and more portable (python path stuff)
Retrieved from "https://wiki.mozilla.org/index.php?title=IT/Production_Acceptance/DXR&oldid=205072"