Skip to contentSkip to conversation

docs: update coverage.markdown

PATCH In review Wei Liu 4 participants 4 messages Oct 20, 2017 – Oct 23, 2017

lore
Share & tools
lore

Wei Liu

author
#0 lore raw

PATCH 1/1 docs: update coverage.markdown

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

---
Cc: Andrew Cooper <[email protected]>
Cc: George Dunlap <[email protected]>
Cc: Ian Jackson <[email protected]>
Cc: Jan Beulich <[email protected]>
Cc: Konrad Rzeszutek Wilk <[email protected]>
Cc: Stefano Stabellini <[email protected]>
Cc: Tim Deegan <[email protected]>
Cc: Wei Liu <[email protected]>
Cc: [email protected]

---
 docs/misc/coverage.markdown | 30 +++++++++---------------------
 1 file changed, 9 insertions(+), 21 deletions(-)
docs/misc/coverage.markdown +9 -21
index 9a88c899b8..6eae44176c 100644
@@ -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
Signature · 7 lines
2.11.0


_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xen.org/xen-devel
#3 lore raw
Quoted 9 lines · Roger Pau Monné
Quoted 3 lines · Wei Liu

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

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

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

Cheers,

Quoted 8 lines

Thanks!

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xen.org/xen-devel

Signature · 6 lines
Julien Grall

_______________________________________________
Xen-devel mailing list
[email protected]
https://lists.xen.org/xen-devel