946011 - Document Valgrind-on-TBPL runs

Status: RESOLVED FIXED

(Tree Management Graveyard :: TBPL, defect)

Description

[Nicholas Nethercote [inactive]]

For Valgrind builds to be unhidden, they need to be documented as per
https://wiki.mozilla.org/Sheriffing/Job_Visibility_Policy#10.29_Has_sufficient_documentation

Comment 1

[Nicholas Nethercote [inactive]]

Ok, I've added an entry on Valgrind to https://developer.mozilla.org/en-US/docs/Mozilla/QA/Automated_testing, which links to a new page https://developer.mozilla.org/en-US/docs/Valgrind_test_job.

Ed, can you please take a look and see what you think?

> For Valgrind builds to be unhidden, they need to be documented as per
> https://wiki.mozilla.org/Sheriffing/Job_Visibility_Policy#10.
> 29_Has_sufficient_documentation

Quoting from that page...

> - Has a wiki page with:

Done.

>   - An overview of the test-suite.

Done.

>   - Instructions for running locally.

Partially done;  the rest is marked "TODO" and is waiting on bug 631811.

>   - How to disable an individual failing test.

N/A;  this job is effectively a single test.  However, I have put some info about suppressions which is sort of equivalent.

>   - The current owner/who to contact for help.

Done.

>   - The Bugzilla product/component where bugs should be filed (Github issues is not discoverable enough and prevents the use of bug dependencies within the rest of the project). 

Not sure what this means.  Does it refer to bugs within the Valgrind job itself?  The Valgrind-on-TBPL tracking bug (bug 631811) is under Testing / New Frameworks, if that's relevant.

> - That wiki page is linked to from https://developer.mozilla.org/docs/Mozilla/QA/Automated_testing

Done.

Comment 2

[Nicholas Nethercote [inactive]]

I've updated the page to fill in the TODOs, in anticipation of bug 631811 landing.  I think the page is good enough now -- I'd appreciate the check, Ed!  Thanks.

Comment 3

[Ed Morley [:emorley]]

That looks great - thank you :-)

(In reply to Nicholas Nethercote [:njn] from comment #1)
> >   - The Bugzilla product/component where bugs should be filed (Github issues is not discoverable enough and prevents the use of bug dependencies within the rest of the project). 
> 
> Not sure what this means.  Does it refer to bugs within the Valgrind job
> itself?  The Valgrind-on-TBPL tracking bug (bug 631811) is under Testing /
> New Frameworks, if that's relevant.

Yeah that's fine :-)

Comment 4

[Nicholas Nethercote [inactive]]

> > The Valgrind-on-TBPL tracking bug (bug 631811) is under Testing /
> > New Frameworks, if that's relevant.
> 
> Yeah that's fine :-)

I added a sentence about filing bugs under that product/component.

And with that done, this bug is finished.  Thanks, Ed.