924535 - Documentation improvements

Status: RESOLVED FIXED

(Testing Graveyard :: Eideticker, defect)

Description

[William Lachance (:wlach)]

I want to make a few improvements to the eideticker README:

1. Better documentation of the get-metric-for-build utility (in particular, we now support FirefoxOS there).
2. Various other nits (e.g. use of B2G instead of FirefoxOS)

Comment 1

[William Lachance (:wlach)]

Attachment: 0001-Bug-924535-Documentation-improvements-r-davehunt.patch

Minor improvements

Comment 2

[William Lachance (:wlach)]

Attachment: 0002-Bug-924535-Improve-documentation-for-getting-individ.patch

Better docs for getting individual results.

Comment 3

[Dave Hunt [:davehunt] [he/him] ⌚BST]

Comment on attachment 814503 [details] [diff] [review]
0002-Bug-924535-Improve-documentation-for-getting-individ.patch

Review of attachment 814503 [details] [diff] [review]:
-----------------------------------------------------------------

::: README.md
@@ +172,4 @@
>  
>  ### Console profiling
>  
> +Console mode allows you to get one-off results of running eideticker for a

Can we capitalize Eideticker for consistency?

@@ +181,5 @@
> +To run get-metric-for-build against an already-installed version of
> +Fennec, specify the name of the test followed by the names of the
> +applications you want to test:
> +
> +    ./bin/get-metric-for-build.py <name of test> [app name 1] [app name 2] ...

For consistency, use <test>

Comment 4

[William Lachance (:wlach)]

Pushed: 

https://github.com/mozilla/eideticker/commit/435c82b892761f49c870691840ae583c088a94e7
https://github.com/mozilla/eideticker/commit/3c3bb1669094c11f5bcf6527458da84ac97daa85