From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id yLepMHaQzWNxNQAAbAwnHQ (envelope-from ) for ; Sun, 22 Jan 2023 20:37:26 +0100 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id wFfbL3aQzWOCMgAAG6o9tA (envelope-from ) for ; Sun, 22 Jan 2023 20:37:26 +0100 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 841F41AFDE for ; Sun, 22 Jan 2023 20:37:26 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pJg9I-00087m-5F; Sun, 22 Jan 2023 14:37:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pJg9G-00087D-W6 for guix-patches@gnu.org; Sun, 22 Jan 2023 14:37:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pJg9G-0006cv-Ny for guix-patches@gnu.org; Sun, 22 Jan 2023 14:37:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pJg9G-0004Il-Cu for guix-patches@gnu.org; Sun, 22 Jan 2023 14:37:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#52109] Mention bsdcat, bsdcpio and bsdtar in description of libarchive Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 22 Jan 2023 19:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 52109 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Liliana Marie Prikler Cc: kiasoc5 , Giovanni Biscuolo , Foo Chuan Wei , 52109@debbugs.gnu.org, zimoun Received: via spool by 52109-submit@debbugs.gnu.org id=B52109.167441618916455 (code B ref 52109); Sun, 22 Jan 2023 19:37:02 +0000 Received: (at 52109) by debbugs.gnu.org; 22 Jan 2023 19:36:29 +0000 Received: from localhost ([127.0.0.1]:52661 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pJg8j-0004HJ-6Z for submit@debbugs.gnu.org; Sun, 22 Jan 2023 14:36:29 -0500 Received: from mail-qv1-f41.google.com ([209.85.219.41]:46645) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pJg8f-0004Gv-5q for 52109@debbugs.gnu.org; Sun, 22 Jan 2023 14:36:27 -0500 Received: by mail-qv1-f41.google.com with SMTP id e19so4480484qvw.13 for <52109@debbugs.gnu.org>; Sun, 22 Jan 2023 11:36:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id :in-reply-to:date:references:subject:cc:to:from:from:to:cc:subject :date:message-id:reply-to; bh=YNe0lbhyqZeSujglndcx3I3EDnsPOf5jw2wEKNzAItY=; b=BoNO1UtQMSNF5M1nMq9+a7csWL6D6hEm8Q+ZWRY2ZVIgK6DjNR7vlDr/vbVvrrWvoO ZyynfOlmIZNKDuQzhtlRvwI5XLHVneglzyn9I6yl+2qpTqZeN47kEKIhdMguOdfewhmm fJruCKOpi9wtaOlHAymrhPZ6YUYkyc8h8IZPyMMYMFgiX7aDgjrnQRaKeNoLVth1ws2f DYs/9qXrkYYblgowtBdp2ICyQ3fJPY+Gzy+jv0FNKnJjGUA1I9d8vJh5Rzrh/xuH6Js/ s8kRQYcEKRPbU9X/PWb43YY2YExUxnjVtAxsprXBH/9QNQOukdoHd1FLKvZMwI3E7Xo/ tQuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:user-agent:message-id :in-reply-to:date:references:subject:cc:to:from:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=YNe0lbhyqZeSujglndcx3I3EDnsPOf5jw2wEKNzAItY=; b=TtZ7+iCpheODzl57SysaTdRzqoX3/7RrM4XqnWl1fLq+RfrXdoQQicae9av32NSVhf Z94DZKBcft9rNfQ47HQsblFtOw8EJkySHpx5YGarvz6I//iBh/SIFP2lkMIlZdjXkiLt i2c1m4Qlvl+NPODZ0M//P5wNbYxgjcsZONnN+EbgoTwppf0vZZjg3Tol8G6yTxlnyYI5 dHFHZt/f4i0+ikKu4zD9BnWWggWhPSzjB/+Sl8o8I1loBINnHxauOD5wGKcGt4hBBShy QbqfeBeQ7VRJwQ2130w0RNZ0YDQWyE1Ij5trxCeumovH6/k+dFXdwCW65QBZiWdHG1c8 /zTg== X-Gm-Message-State: AFqh2kqYVNpxmisoE+IrJFTIwA9E1jOSepn0lwhG3ROPlFm2SUNCCYZM 5xHJwP7+nG/eJ9BSW04WIWI= X-Google-Smtp-Source: AMrXdXs2CutApLh5snyWmPMxbHdYwQaKCzatSe4gjw/UE0aJ7vZtYP2/I+PTDu1RWx+6scseQfkyNQ== X-Received: by 2002:a0c:9c8a:0:b0:531:b7b1:c31e with SMTP id i10-20020a0c9c8a000000b00531b7b1c31emr31574516qvf.38.1674416179648; Sun, 22 Jan 2023 11:36:19 -0800 (PST) Received: from hurd ([2607:fad8:4:3::1001]) by smtp.gmail.com with ESMTPSA id q15-20020a05620a038f00b00704a2a40cf2sm4930693qkm.38.2023.01.22.11.36.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 22 Jan 2023 11:36:19 -0800 (PST) From: Maxim Cournoyer References: <877cxqwjen.fsf@gmail.com> <87o7qyvmkp.fsf@gmail.com> <69bf571edfe9834851ddcd9f93e8158983b42612.camel@gmail.com> <87bkmytoy6.fsf@gmail.com> <86bkmr3m4t.fsf@gmail.com> <86k01e1u8k.fsf@gmail.com> <54d6f7d65b6ece07dcd758449fd833f3290f44a4.camel@gmail.com> Date: Sun, 22 Jan 2023 14:36:18 -0500 In-Reply-To: <54d6f7d65b6ece07dcd758449fd833f3290f44a4.camel@gmail.com> (Liliana Marie Prikler's message of "Sun, 22 Jan 2023 18:44:45 +0100") Message-ID: <87edrm1hvx.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) 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: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1674416246; 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=YNe0lbhyqZeSujglndcx3I3EDnsPOf5jw2wEKNzAItY=; b=WGGcmHoGcIG9p8bzmGIWbpNBtXi+WhfHnIRh4w884K9/X97AYJatvnNsW17WxQLwwGQYe3 E3V6GPvNGicxKx7TmEYsIoxndJ+G6QDHAFQ3uMfncP2+DY//Y4rXQDUOdztVb/E29pugCc 2ntuYboRzSeHqrjOQvmN9fDiu5wisb2vo2rb525WaOIg9Xo872bOwVbA4U43pdNAvtARZ8 5gQjJOqgQ5fc6Lb0kvsSOGTmFAoKcz0ftUVx0INNZsFPrfunTP4naUkkEnG8qneV6hcd7L K0U1fNJyMXM6vO47hkimWkamO2cdF/Lblmp+kuLAV6x+MS6+ZyiynjaWwT4LaA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=BoNO1UtQ; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1674416246; a=rsa-sha256; cv=none; b=MOk266ENljTe7Nbth55xbxCsCLiiR5MKF70ibR3/8BjZ/Jm0ZAw/mG6qrBo8V/2He3mPsJ Hv3djONzZ0sZ7xqZGHMjs1ltp376kfAkq18QmcdgQwD02sDaGO+kIa0FJO8GvNZBg+gYJD FaNE0937l+BrBc/lmCBpvF1UeeQElk1K4ePlCxRJ266NhvKztlIQUSY4xwog415xF3jWZg Q76pmnwTZ2JmJPdrwtPWtUxsNqQH47piA7b5BHNPPtoWnicJLpuUs/6/zGs3VWRNKEJRiu 1NUwovd7q1zW+XmNUi0fdzqr0j0tSqT6TaQjGidg2J80vv3LhRO6rpQFU+ZEYQ== X-Migadu-Spam: Yes X-Migadu-Scanner: scn1.migadu.com X-Migadu-Spam-Score: 8.91 X-Spam-Score: 8.91 X-Migadu-Queue-Id: 841F41AFDE X-Spam: Yes Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=BoNO1UtQ; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-TUID: OFKtIPrZzXuU Hi Liliana, Liliana Marie Prikler writes: > Am Sonntag, dem 22.01.2023 um 16:09 +0100 schrieb zimoun: >> Hi, >>=20 >> On Sat, 21 Jan 2023 at 18:59, Liliana Marie Prikler >> wrote: >>=20 >> > > Please find attach the patch. :-)=C2=A0 If it appears to you fine, >> > > could you merge it? >> >=20 >> > Hmm, I fear that this line doesn't do much except helping folk to >> > grep for "bsdtar" et al.=C2=A0 Should we perhaps explain in a sentence >> > or two what those commands do? >>=20 >> It is not =E2=80=99grep=E2=80=99 but =E2=80=9Cguix search=E2=80=9D so it= is only an internal SEO. ;-) >>=20 >> From my point of view, some explanations about what these commands do >> are done by the man pages. >>=20 >> Well, this trivial patch is just a quick workaround at 2 levels.=C2=A0 >> One, because Guix File Search [1] is almost done but not very popular >> yet. > Fair enough. > >> Two, because this libarchive should be split into 2 different >> packages or outputs: one for the library itself and another for the >> commands. >>=20 >> 1: > Splitting libarchive outputs is sadly a core-updates change, but we > could hide the existing one and add a user-facing one with the split if > that's what you desire. I don't think adding a package for just the > tools has merits. > >> However, if a table containing what these utilities do seems >> appropriated, here the description from the Debian package >> =E2=80=99libarchive-tools=E2=80=99: >>=20 >> --8<---------------cut here---------------start------------->8--- >> The bsdtar program is the default system 'tar' program used on >> FreeBSD. bsdtar uses the libarchive library as a backend which does >> all of the work for reading and writing archives in various formats. >>=20 >> The bsdcpio program is the default system 'cpio' program used on >> FreeBSD. bsdcpio uses the libarchive library as a backend which does >> all of the work for reading and writing archives in various formats >>=20 >> The bsdcat program reads archived data from files or from its >> standard input and uses the libarchive library to decompresses it to >> its standard output. It may be used for viewing the contents of >> archives or for passing it to other tools for further processing. >> --8<---------------cut here---------------end--------------->8--- > I think these could be shortened as follows: > > This package/the 'bin' output also provides > @itemize > @item @command{bsdtar} and @command{bsdcpio} to pack/unpack archives > like @command{tar} and @command{cpio} respectively, and > @item @command{bsdcat} to concatenate files like @command{cat} does, > while transparently unpacking archives. > @end itemize Like Simon, I think just mentioning the commands solve the lack of discovery problem that they reported about these commands; the details themselves can be further looked up by users via the manpages or --help output, since the above description wouldn't provide much more than what can be guessed already. I pushed Simon's suggested change. --=20 Thanks, Maxim