[gmx-developers] Code Browser (dev call follow up)

[Eric Irrgang]

Hello,

I share the skepticism about documentation that does not reflect the patch
under consideration, though hopefully commits are small enough this isn't
an issue.

I didn't get around to actually trying to set up the woboq software for
Gromacs because Roland's email indicated I would need to use Firefox or
Chrome and it looked like a fair bit of a hassle, but the examples look
nice...

What I'm finding is useful for me, though, is to toggle a few Doxygen
config options, such as 'SOURCE_BROWSER = YES' and 'HIDE_UNDOC_CLASSES =
NO' which makes it super-easy to cross-reference stuff. I'm thinking of
submitting a change request to add a more verbose doc-building option
('doxygen-fuller'?), but since Gerrit already causes builds for uploaded
patches, could Jenkins or Gerrit host an extra-verbose (but minimally
graphical) copy of the docs for each patch? Could it be linked from the
commit message or something not-too-onerous to add/maintain in the code
review page?

Thank you for this initiative!
Eric

On Wed, Feb 1, 2017 at 8:26 AM, Mark Abraham <mark.j.abraham at gmail.com>
wrote:

> Hi,
>
> It could help a bit, particularly with giving people more ability to feel
> confident in reviewing the code without having to do a full checkout.
> However, if the patch under review changes aspects of the API, how does
> that work? Relying on a nightly build for the infrastructure behind the
> click-to-jump-to-definition seems like it might have too much friction.
>
> People with less experience of the code base than me should particularly
> speak up here. :-) You're the market where this has a large impact.
>
> Mark
>
> On Wed, Feb 1, 2017 at 1:58 AM Schulz, Roland <roland.schulz at intel.com>
> wrote:
>
>> Hi,
>>
>> As I mentioned on the last developer call, there is a code browser and
>> Gerrit integration available. One can click on a function in Gerrit to go
>> the definition and usages. It is available in the QT Gerrit and it looks
>> like http://imgur.com/Q3a2ixz . The links go to
>> https://code.woboq.org/qt5/qtbase/src/corelib/io/qurl.cpp.html#_
>> ZN4QUrl13fromLocalFileERK7QString and https://code.woboq.org/data/
>> symbol.html?root=../qt5/&ref=_ZN4QUrl13fromLocalFileERK7QString#uses
>>
>> It can be tried out on https://codereview.qt-project.org after
>> installing https://code.woboq.org/qt-gerrit.user.js which requires
>> Greasmonkey for Firefox / Tampermonkey for Chrome. A bit more detail about
>> the integration is at http://lists.qt-project.org/
>> pipermail/development/2016-May/025733.html and the about the code
>> browser at https://woboq.com/codebrowser.html .
>>
>> Do you think this would help with productivity in code review making it
>> worth taking the time installing it? The installation instructions are at
>> https://github.com/woboq/woboq_codebrowser/blob/master/README.md
>>
>> Roland
>>
>> --
>> Gromacs Developers mailing list
>>
>> * Please search the archive at http://www.gromacs.org/
>> Support/Mailing_Lists/GMX-developers_List before posting!
>>
>> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>>
>> * For (un)subscribe requests visit
>> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-developers
>> or send a mail to gmx-developers-request at gromacs.org.
>>
>
> --
> Gromacs Developers mailing list
>
> * Please search the archive at http://www.gromacs.org/
> Support/Mailing_Lists/GMX-developers_List before posting!
>
> * Can't post? Read http://www.gromacs.org/Support/Mailing_Lists
>
> * For (un)subscribe requests visit
> https://maillist.sys.kth.se/mailman/listinfo/gromacs.org_gmx-developers
> or send a mail to gmx-developers-request at gromacs.org.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://maillist.sys.kth.se/pipermail/gromacs.org_gmx-developers/attachments/20170217/7e921afa/attachment.html>