Hello,
Thank you for your patch. This looks like an interesting tool! Itest-compiled this, and I have a couple comments.
Olivier Dion <olivier.dion@polymtl.ca> writes:
Toggle quote (4 lines)
> * gnu/packages/linux.scm (babeltrace): New variable.>> Signed-off-by: Olivier Dion <olivier.dion@polymtl.ca>
"We" don't used signed-off-by like this (signed-off-by is used by thecommitter who is pushing your patch); you can leave it out.
Toggle quote (25 lines)
> ---> gnu/packages/linux.scm | 35 +++++++++++++++++++++++++++++++++++> 1 file changed, 35 insertions(+)>> diff --git a/gnu/packages/linux.scm b/gnu/packages/linux.scm> index 9bb90e599e..dcfea9cc6c 100644> --- a/gnu/packages/linux.scm> +++ b/gnu/packages/linux.scm> @@ -131,6 +131,7 @@> #:use-module (gnu packages sdl)> #:use-module (gnu packages serialization)> #:use-module (gnu packages slang)> + #:use-module (gnu packages sphinx)> #:use-module (gnu packages sqlite)> #:use-module (gnu packages texinfo)> #:use-module (gnu packages tls)> @@ -8051,6 +8052,40 @@ enable and disable specific instrumentation points, and writes event records> to ring buffers shared with a consumer daemon.")> (license license:lgpl2.1+)))> > +(define-public babeltrace> + (package> + (name "babeltrace")> + (version "2.0.3")
2.0.4 is available; is there a particular reason for using 2.0.3?
Toggle quote (12 lines)
> + (source (origin> + (method url-fetch)> + (uri (string-append "https://www.efficios.com/files/babeltrace/babeltrace2-"> + version ".tar.bz2"))> + (sha256> + (base32 "1804pyq7fz6rkcz4r1abkkn0pfnss13m6fd8if32s42l4lajadm5"))))> +> + (build-system gnu-build-system)> +> + (propagated-inputs> + `(("elfutils" ,elfutils)))
Is there a reason why this is propagated? It seems like babeltrace usesit for the libraries and headers only, so it should probably be in 'inputs'.
Toggle quote (7 lines)
> +> + (native-inputs> + `(("asciidoc" ,asciidoc)> + ("bison" ,bison)> + ("flex" ,flex)> + ("glib" ,glib)
guix gc --references /gnu/store/mm02i199mwwqgazk6fphz6rka8ga4fh6-babeltrace-2.0.3
says that babeltrace retains a reference to glib, so it should probablybe a regular input as well.
Toggle quote (12 lines)
> + ("pkg-config" ,pkg-config)> + ("python" ,python-3)> + ("python-sphinx" ,python-sphinx)> + ("xmltoman" ,xmltoman)))> +> + (home-page "https://babeltrace.org/")> + (synopsis "Babeltrace /ˈbæbəltreɪs/ is an open-source trace manipulation toolkit.")> + (description "Babeltrace 2 is the reference parser implementation of the> +Common Trace Format (CTF), a versatile trace format produced by various> +tracers and tools such as LTTng and barectf. The Babeltrace 2 library and its> +Python bindings can read and write CTF traces.")
Toggle snippet (6 lines)
$ ./pre-inst-env guix lint babeltrace/home/sarah/guix-apply/gnu/packages/linux.scm:8170:17: babeltrace@2.0.3: sentences in description should be followed by two spaces; possible infraction at 174/home/sarah/guix-apply/gnu/packages/linux.scm:8169:14: babeltrace@2.0.3: no period allowed at the end of the synopsis/home/sarah/guix-apply/gnu/packages/linux.scm:8169:14: babeltrace@2.0.3: synopsis should not start with the package name
Synopses should reduce to a noun; open-source is implied by itsinclusion in Guix; the pronunciation is more suited to the description,but may not be necessary at all.
Consider: "Trace manipulation toolkit" or "Trace manipulation toolkitwith Python bindings" (depending on what the focus should be on)
In the description, it may be worth mentioning that it provides thecommand-line tool "@command{babeltrace2}"; consider referencing themanual page for wording.
You could even start with something like:
"Babeltrace 2 is a framework for viewing, converting, transforming, andanalyzing traces. It is also the reference parser implementation of theCommon Trace Format (CTF), produced by tools such as LTTng and barectf.This package provides a library with a C API, Python 3 bindings, and thecommand-line tool @command{babeltrace2}."
That's just an example though! It could definitly be improved.
Hope that helps,--Sarah