From: Peter Elliott <pelliott@ualberta.ca>
To: guile-devel@gnu.org
Subject: [PATCH] fix incorrect documentation for coverage-data->lcov
Date: Tue, 27 Aug 2019 20:42:48 -0700 [thread overview]
Message-ID: <CAM7JtP1NUGzdGtLL6F068SFXKO02bTs11mvN=TJY6AdBJes6MA@mail.gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 173 bytes --]
Hello,
coverage-data->lcov does not, and never has taken a 'modules'
argument, so I've removed it.
However, I would really like this, and might add it if it's not too hard.
[-- Attachment #2: 0001-Remove-modules-arg-from-coverage-data-lcov-doc.patch --]
[-- Type: text/x-patch, Size: 1387 bytes --]
From e0dbb70625d1dd850924122c64639994e2fed3b5 Mon Sep 17 00:00:00 2001
From: Peter Elliott <pelliott@ualberta.ca>
Date: Tue, 27 Aug 2019 20:19:15 -0700
Subject: [PATCH] Remove modules arg from coverage data->lcov doc
---
doc/ref/api-coverage.texi | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/ref/api-coverage.texi b/doc/ref/api-coverage.texi
index 5081d343b..92ae606b6 100644
--- a/doc/ref/api-coverage.texi
+++ b/doc/ref/api-coverage.texi
@@ -25,12 +25,12 @@ Return @code{#t} if @var{obj} is a @dfn{coverage data} object as returned by
@code{with-code-coverage}.
@end deffn
-@deffn {Scheme Procedure} coverage-data->lcov data port #:key modules
+@deffn {Scheme Procedure} coverage-data->lcov data port
Traverse code coverage information @var{data}, as obtained with
@code{with-code-coverage}, and write coverage information to port in the
@code{.info} format used by @url{http://ltp.sourceforge.net/coverage/lcov.php,
-LCOV}. The report will include all of @var{modules} (or, by default, all the
-currently loaded modules) even if their code was not executed.
+LCOV}. The report will include all the modules loaded at the time coverage data was
+gathered, even if their code was not executed.
The generated data can be fed to LCOV's @command{genhtml} command to produce an
HTML report, which aids coverage data visualization.
--
2.22.1
next reply other threads:[~2019-08-28 3:42 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-28 3:42 Peter Elliott [this message]
2019-08-28 20:42 ` [PATCH] fix incorrect documentation for coverage-data->lcov Timothy Sample
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAM7JtP1NUGzdGtLL6F068SFXKO02bTs11mvN=TJY6AdBJes6MA@mail.gmail.com' \
--to=pelliott@ualberta.ca \
--cc=guile-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).