[for-4.10] docs: update coverage.markdown

Commit Message

Wei Liu Oct. 20, 2017, 4:30 p.m. UTC

The coverage support in hypervisor is redone. Update the document.

Signed-off-by: Wei Liu <[e-mail]>
---
Cc: Andrew Cooper <[e-mail]>
Cc: George Dunlap <[e-mail]>
Cc: Ian Jackson <[e-mail]>
Cc: Jan Beulich <[e-mail]>
Cc: Konrad Rzeszutek Wilk <[e-mail]>
Cc: Stefano Stabellini <[e-mail]>
Cc: Tim Deegan <[e-mail]>
Cc: Wei Liu <[e-mail]>
Cc: [e-mail]
---
 docs/misc/coverage.markdown | 30 +++++++++---------------------
 1 file changed, 9 insertions(+), 21 deletions(-)

Comments

Ian Jackson Oct. 20, 2017, 4:55 p.m. UTC | #1

Wei Liu writes ("[PATCH for-4.10] docs: update coverage.markdown"):
> The coverage support in hypervisor is redone. Update the document.

Acked-by: Ian Jackson <[e-mail]>

Roger Pau Monné Oct. 20, 2017, 5:08 p.m. UTC | #2

On Fri, Oct 20, 2017 at 05:30:41PM +0100, Wei Liu wrote:
> The coverage support in hypervisor is redone. Update the document.
> 
> Signed-off-by: Wei Liu <[e-mail]>

Adding Julien, although I'm not sure if doc changes also need a
release-ack.

Reviewed-by: Roger Pau Monné <[e-mail]>

Thanks!

Julien Grall Oct. 23, 2017, 11:10 a.m. UTC | #3

On 20/10/17 18:08, Roger Pau Monné wrote:
> On Fri, Oct 20, 2017 at 05:30:41PM +0100, Wei Liu wrote:
>> The coverage support in hypervisor is redone. Update the document.
>>
>> Signed-off-by: Wei Liu <[e-mail]>
> 
> Adding Julien, although I'm not sure if doc changes also need a
> release-ack.
> 
> Reviewed-by: Roger Pau Monné <[e-mail]>

I would forgo it for documentation. Such patches can only make release 
the better :).

Cheers,

> 
> Thanks!
> 
> _______________________________________________
> Xen-devel mailing list
> [e-mail]
> https://lists.xen.org/xen-devel
>

Patch

diff --git a/docs/misc/coverage.markdown b/docs/misc/coverage.markdown
index 9a88c899b8..6eae44176c 100644
--- a/docs/misc/coverage.markdown
+++ b/docs/misc/coverage.markdown
@@ -10,38 +10,26 @@  down your hypervisor.
 
 ## Enable coverage
 
-Test coverage support can be turned on compiling Xen with the `coverage` option set
-to `y`.
+Test coverage support can be turned on compiling Xen with the `CONFIG_GCOV`
+option set to `y`.
 
-Something like:
-
-    cd xen
-    make coverage=y
-
-(or change your `.config` file).
+Change your `.config` or run `make -C xen menuconfig`.
 
 ## Extract coverage data
 
-The way GCC and other tools deal with coverage information is to use some files
-created during build phase (.gcno) and some files produced by executing the
-*program* (.gcda). The program in this case is Xen but Xen cannot write files
-so the way you can use coverage from Xen is extract coverage data from Xen and
-then split these information into files.
-
-To extract data you use a simple utility called `xencov`. Mainly `xencore`
-allows you to do 3 operations:
+To extract data you use a simple utility called `xencov`.
+It allows you to do 2 operations:
 
 * `xencov read` extract data
 * `xencov reset` reset all coverage counters
-* `xencov read-reset` extract data and reset counters at the same time.
 
-Another utility (`xencov_split`) is used to split extracted data file into files
-needed by userspace tools.
+Another utility (`xencov_split`) is used to split extracted data file into
+files needed by userspace tools.
 
 ## Split coverage data
 
-Once you extracted data from Xen, it is time to create files which the coverage tools
-can understand. To do it you need to run `xencov_split` utility.
+Once you extracted data from Xen, it is time to create files which the coverage
+tools can understand. To do it you need to run `xencov_split` utility.
 
 The utility just takes an input file and splits the blob into gcc .gcda files
 in the same directory that you execute the script. As file names are generated