From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <guix-patches-bounces+larch=yhetil.org@gnu.org>
Received: from mp0 ([2001:41d0:2:4a6f::])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits))
	by ms0.migadu.com with LMTPS
	id yCpgDP7VTGEfYAEAgWs5BA
	(envelope-from <guix-patches-bounces+larch=yhetil.org@gnu.org>)
	for <larch@yhetil.org>; Thu, 23 Sep 2021 21:31:10 +0200
Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits))
	by mp0 with LMTPS
	id cD4ICP7VTGHjVgAA1q6Kng
	(envelope-from <guix-patches-bounces+larch=yhetil.org@gnu.org>)
	for <larch@yhetil.org>; Thu, 23 Sep 2021 19:31:10 +0000
Received: from lists.gnu.org (lists.gnu.org [209.51.188.17])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by aspmx1.migadu.com (Postfix) with ESMTPS id 7F64E9D92
	for <larch@yhetil.org>; Thu, 23 Sep 2021 21:31:09 +0200 (CEST)
Received: from localhost ([::1]:55500 helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <guix-patches-bounces+larch=yhetil.org@gnu.org>)
	id 1mTUR2-0007rM-K4
	for larch@yhetil.org; Thu, 23 Sep 2021 15:31:08 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:43192)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
 id 1mTUQw-0007r3-81
 for guix-patches@gnu.org; Thu, 23 Sep 2021 15:31:02 -0400
Received: from debbugs.gnu.org ([209.51.188.43]:44371)
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.90_1) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
 id 1mTUQw-0007Yt-07
 for guix-patches@gnu.org; Thu, 23 Sep 2021 15:31:02 -0400
Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2)
 (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1mTUQv-0003Is-Qs
 for guix-patches@gnu.org; Thu, 23 Sep 2021 15:31:01 -0400
X-Loop: help-debbugs@gnu.org
Subject: [bug#50757] [PATCH] gnu: Add babeltrace.
Resent-From: Sarah Morgensen <iskarian@mgsn.dev>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
Resent-CC: guix-patches@gnu.org
Resent-Date: Thu, 23 Sep 2021 19:31:01 +0000
Resent-Message-ID: <handler.50757.B50757.163242541412628@debbugs.gnu.org>
Resent-Sender: help-debbugs@gnu.org
X-GNU-PR-Message: followup 50757
X-GNU-PR-Package: guix-patches
X-GNU-PR-Keywords: patch
To: Olivier Dion <olivier.dion@polymtl.ca>
Cc: 50757@debbugs.gnu.org
Received: via spool by 50757-submit@debbugs.gnu.org id=B50757.163242541412628
 (code B ref 50757); Thu, 23 Sep 2021 19:31:01 +0000
Received: (at 50757) by debbugs.gnu.org; 23 Sep 2021 19:30:14 +0000
Received: from localhost ([127.0.0.1]:55917 helo=debbugs.gnu.org)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <debbugs-submit-bounces@debbugs.gnu.org>)
 id 1mTUQ9-0003Hc-O5
 for submit@debbugs.gnu.org; Thu, 23 Sep 2021 15:30:14 -0400
Received: from out2.migadu.com ([188.165.223.204]:56337)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <iskarian@mgsn.dev>) id 1mTUQ6-0003HM-Ar
 for 50757@debbugs.gnu.org; Thu, 23 Sep 2021 15:30:12 -0400
X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and
 include these headers.
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mgsn.dev; s=key1;
 t=1632425409;
 h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
 content-transfer-encoding:content-transfer-encoding:
 in-reply-to:in-reply-to:references:references;
 bh=3KMjTzqfRvEYFtN9XAFk2Ms0vtOfdliYSv14JPGS5JM=;
 b=j3VN6fh8T6fowDxit9OQ9GU6dRKy/NV55io9g3sLl2p96WDBXk3hU3oyIo5QyvCHaOiu5f
 6s8SGS6rm2TtGXvcW6i4zR3Cc60wP1WYrec8n/KAn5kIB1umvpi0cl/VSQ72XOa07hlshC
 Rj6f9CZX0pa+8RmjKWaP+RBrD/O+G4c=
From: Sarah Morgensen <iskarian@mgsn.dev>
References: <20210923124113.3269-1-olivier.dion@polymtl.ca>
Date: Thu, 23 Sep 2021 12:30:06 -0700
In-Reply-To: <20210923124113.3269-1-olivier.dion@polymtl.ca> (Olivier Dion's
 message of "Thu, 23 Sep 2021 08:41:13 -0400 (5 hours, 59 minutes, 55
 seconds ago)")
Message-ID: <86k0j7ks3l.fsf@mgsn.dev>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-BeenThere: debbugs-submit@debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
X-BeenThere: guix-patches@gnu.org
List-Id: <guix-patches.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-patches>,
 <mailto:guix-patches-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/guix-patches>
List-Post: <mailto:guix-patches@gnu.org>
List-Help: <mailto:guix-patches-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-patches>,
 <mailto:guix-patches-request@gnu.org?subject=subscribe>
Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org
Sender: "Guix-patches" <guix-patches-bounces+larch=yhetil.org@gnu.org>
X-Migadu-Flow: FLOW_IN
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org;
	s=key1; t=1632425469;
	h=from:from:sender:sender:reply-to:subject:subject:date:date:
	 message-id:message-id:to:to:cc:cc:mime-version:mime-version:
	 content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding:resent-cc:
	 resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to:
	 references:references:list-id:list-help:list-unsubscribe:
	 list-subscribe:list-post:dkim-signature;
	bh=3KMjTzqfRvEYFtN9XAFk2Ms0vtOfdliYSv14JPGS5JM=;
	b=hpC3so3ybpkjVoyB4vI971fh0OJxjxwnA8vLsHpghgRWuLqyUqFbxThxxjDMuAwVF2Yn86
	/5m1NL6wk3ywzVOsXiiRtPre3Qtk5uCSsW7U63J2U+iVdYWQfoECLtSY1mq2gNpbgdAVja
	gRE9idELJONejw9L5pRxzSGWP1cF/hNvBvcbsBDW7eYnXdI8zgCtGFVKZuGcc6OPNitmth
	lHKzkdDujmF3xVzGLDUSTnrXDTSM1Gr/jTFJimNXJ1j53A/5zOkOaB3FgEjkXet5/eCtxC
	nWFGs7cs6jEa4qyg7lSnprHUkCovultRU+OJcyF5IoSc4mZz21D6lD/1q+e9SA==
ARC-Seal: i=1; s=key1; d=yhetil.org; t=1632425469; a=rsa-sha256; cv=none;
	b=VeonQYPtbNf20lcydhoK10KUKks6Xepx19mci76yW09b7HaWYDKXzLxATvq1dbl3J2eQCY
	0goKnwPNuz5YPCDKf4pDCNfpDKVLok/8Bn8DmGu6/QIWPVYj+zfLORiCxyJe9WjthW1xFh
	2oXb//CXfkzMcFCrh7JxaQQUaW467eV5uD5ZQxwZwn9daSO5j8twJpnY5CyE3riY07N8RU
	vpcMDEjBsBUpJ2eeE5RZr4XfYnulPMopjOClAUXaidy+9H/cnBp3DE0MYnDgFsxY9X/3jl
	J+LaeqhXNYaYlW+RT8SrHgg3R/mc1Yfo0/+CWCa9JzRahSXqBvnqqRPOfdP7jw==
ARC-Authentication-Results: i=1;
	aspmx1.migadu.com;
	dkim=fail ("headers rsa verify failed") header.d=mgsn.dev header.s=key1 header.b=j3VN6fh8;
	dmarc=fail reason="SPF not aligned (relaxed)" header.from=mgsn.dev (policy=none);
	spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org
X-Migadu-Spam-Score: 0.21
Authentication-Results: aspmx1.migadu.com;
	dkim=fail ("headers rsa verify failed") header.d=mgsn.dev header.s=key1 header.b=j3VN6fh8;
	dmarc=fail reason="SPF not aligned (relaxed)" header.from=mgsn.dev (policy=none);
	spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org
X-Migadu-Queue-Id: 7F64E9D92
X-Spam-Score: 0.21
X-Migadu-Scanner: scn0.migadu.com
X-TUID: T4FGF7kxU5gw

Hello,

Thank you for your patch.  This looks like an interesting tool!  I
test-compiled this, and I have a couple comments.

Olivier Dion <olivier.dion@polymtl.ca> writes:

> * 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 the
committer who is pushing your patch); you can leave it out.

> ---
>  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+)))
>=20=20
> +(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?

> +    (source (origin
> +              (method url-fetch)
> +              (uri (string-append "https://www.efficios.com/files/babelt=
race/babeltrace2-"
> +                                  version ".tar.bz2"))
> +              (sha256
> +               (base32 "1804pyq7fz6rkcz4r1abkkn0pfnss13m6fd8if32s42l4laj=
adm5"))))
> +
> +    (build-system gnu-build-system)
> +
> +    (propagated-inputs
> +     `(("elfutils" ,elfutils)))

Is there a reason why this is propagated?  It seems like babeltrace uses
it for the libraries and headers only, so it should probably be in 'inputs'.

> +
> +    (native-inputs
> +     `(("asciidoc" ,asciidoc)
> +       ("bison" ,bison)
> +       ("flex" ,flex)
> +       ("glib" ,glib)

  guix gc --references /gnu/store/mm02i199mwwqgazk6fphz6rka8ga4fh6-babeltra=
ce-2.0.3

says that babeltrace retains a reference to glib, so it should probably
be a regular input as well.

> +       ("pkg-config" ,pkg-config)
> +       ("python" ,python-3)
> +       ("python-sphinx" ,python-sphinx)
> +       ("xmltoman" ,xmltoman)))
> +
> +    (home-page "https://babeltrace.org/")
> +    (synopsis "Babeltrace /=CB=88b=C3=A6b=C9=99ltre=C9=AAs/ is an open-s=
ource 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 an=
d its
> +Python bindings can read and write CTF traces.")

--8<---------------cut here---------------start------------->8---
$ ./pre-inst-env guix lint babeltrace
/home/sarah/guix-apply/gnu/packages/linux.scm:8170:17: babeltrace@2.0.3: se=
ntences in description should be followed by two spaces; possible infractio=
n 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: sy=
nopsis should not start with the package name
--8<---------------cut here---------------end--------------->8---

Synopses should reduce to a noun; open-source is implied by its
inclusion in Guix; the pronunciation is more suited to the description,
but may not be necessary at all.

Consider: "Trace manipulation toolkit" or "Trace manipulation toolkit
with Python bindings" (depending on what the focus should be on)

In the description, it may be worth mentioning that it provides the
command-line tool "@command{babeltrace2}"; consider referencing the
manual page for wording.

You could even start with something like:

"Babeltrace 2 is a framework for viewing, converting, transforming, and
analyzing traces.  It is also the reference parser implementation of the
Common Trace Format (CTF), produced by tools such as LTTng and barectf.
This package provides a library with a C API, Python 3 bindings, and the
command-line tool @command{babeltrace2}."

That's just an example though!  It could definitly be improved.

Hope that helps,
--
Sarah