From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:1008:1e59::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id sHwELhqfnGV/oQAAkFu2QA (envelope-from ) for ; Tue, 09 Jan 2024 02:19:22 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id iH6WJhqfnGVySAEA62LTzQ (envelope-from ) for ; Tue, 09 Jan 2024 02:19:22 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=IdNWarzA; 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"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1704763162; 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=TsTZ4dfo4emd7Qqim37eEKux/muCb2eYzblD8HCvAA4=; b=CVZSaa4MoXOeu+TyhgJEuF+fpZr9udaa6PmkkBREtmMtj35Gih+P3B8vMknudo2J8WviX6 Lk8Q/qKRyCBdpliF3H3rWQ5yr7lqqRyk0Q3yeBnrFNrUeoKM2dUSgryTe/Bf6NNg/wxsqW 1U9PIkKqPmIswdliFCP9pOwA1JUIaWY6ThhYjB9ESv4c7ZgkqgOl5qu+AxUGjFY3Exy/8D /I+35r3cudq/MTf57rmEIzjhPw7B+2nbJkQIgC6hpT8X26G8hNB0Qk/nkDPblQdbzho3F9 rkr/iJHH8I6hYFr4gGafuc+sVoQvkrctL2E8U1MQytCJMVu1uPn7dpdshx5LWw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1704763162; a=rsa-sha256; cv=none; b=ZeXNvmT7GQVIzhEQSXuDA0tBKyrZSiOUd4Mpp4vg8FQ/MoUBMPvURZhECp40zOlZpCUY5z ltFFTwdqfIWWTvqVLPHriKWoMIOu1x3sTdIBRS3nplCkivOnAgT/ckqDZQvYvFqyADyi0U vhiKFvSe3KsW3y3J+sCDTELKFkIRfWkQDsFVkPiKYw37XGhRCsa0Sc6AIdVHxKGbC+4hqV lATjq+Fx+NKeDWZu6G1wVlpeUpb96DjyrsqVwytSqZIZaOu2tsRy5uWdejJRhObPndtM8M JRW7aDkN9/Me3ObVt4kxdCBL/KG7ZfrRxZoIllRzxSTfSmzfAsS1zwngDDkw1g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=IdNWarzA; 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"; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none) 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 D759D678A0 for ; Tue, 9 Jan 2024 02:19:21 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rN0ld-00053y-Kt; Mon, 08 Jan 2024 20:18:57 -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 1rN0lb-00053q-Nv for guix-patches@gnu.org; Mon, 08 Jan 2024 20:18:56 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rN0lb-0008Tm-8x for guix-patches@gnu.org; Mon, 08 Jan 2024 20:18:55 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rN0lh-0004bK-I4 for guix-patches@gnu.org; Mon, 08 Jan 2024 20:19:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#68242] [core-updates] Compress man pages using zstd Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 09 Jan 2024 01:19:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68242 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Ludovic =?UTF-8?Q?Court=C3=A8s?= Cc: 68242@debbugs.gnu.org Received: via spool by 68242-submit@debbugs.gnu.org id=B68242.170476309117614 (code B ref 68242); Tue, 09 Jan 2024 01:19:01 +0000 Received: (at 68242) by debbugs.gnu.org; 9 Jan 2024 01:18:11 +0000 Received: from localhost ([127.0.0.1]:37945 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rN0ks-0004a1-Ag for submit@debbugs.gnu.org; Mon, 08 Jan 2024 20:18:10 -0500 Received: from mail-qv1-xf36.google.com ([2607:f8b0:4864:20::f36]:54423) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rN0kn-0004ZR-Q6 for 68242@debbugs.gnu.org; Mon, 08 Jan 2024 20:18:08 -0500 Received: by mail-qv1-xf36.google.com with SMTP id 6a1803df08f44-67f7bd86cafso20637606d6.0 for <68242@debbugs.gnu.org>; Mon, 08 Jan 2024 17:17:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1704763073; x=1705367873; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=TsTZ4dfo4emd7Qqim37eEKux/muCb2eYzblD8HCvAA4=; b=IdNWarzA/cIDLI+uLVl834d+WNW2klpPTSiJN0oZS2FMe8+kqe6+tz/QQ+c8wVJhl8 Q+n7BculTj8EMs+mjEu+yFpyIM10d+yLnP2LelRGgARwndMRRN6r3EtV8NHiORQaC3pb Bzt5UFMlBwz8XVIDv0n7u5qk+q60SQBDjtfBNovH088reFmTiNLA7edAh4Uc1OS7L0Fo TqXNVkOF/89DdRi8d/b8z+++JJIxou7W9VW/0N3dz5pktlOqPV2q1LaClAoJfjduZyaa sERAQXmaUBIXXbh7SYyYq+LQx27MJfzm/jcE+AZG3YfhwWwXM9CPgyU1ZcjAlaOOWQVu 6+2g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1704763073; x=1705367873; h=content-transfer-encoding:mime-version:user-agent:message-id:date :references:in-reply-to:subject:cc:to:from:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=TsTZ4dfo4emd7Qqim37eEKux/muCb2eYzblD8HCvAA4=; b=wsF/rsTuhLO6GfhdfEgo+iU3ZWoPHVhonmneWzwr1NjCbneEaUYX0keTN8xpFE2BOp TdQ6racgneOGX6WiUWKvlgyy+JYidk7p0we9X/aEh9dL+UQ52ddSDax4qghhRE5VYbBQ dgQzdlqdEr3pR19I6U9QMDT/aQY79S9CYTMzfwCdkmp5j7/jdBR1QdotW9I9kxMbWBXR /ogeBZ1DYIaX53KNPjJb5f+PO/cEWU3vn6zT0TkoeNq+uuUlwQS1jSeEREOLy9HnJU6J Nmg5Pwuc8nkrsipzqj0Dx36nJDwfQd10RZF4iq6k5zsEqu/ajWl8fsmIpUGgOtfXAoWd yBXw== X-Gm-Message-State: AOJu0Yw0fiCbFTKD7AyVjgCCABF8TucU/zrcRN//xvnmM7YK/JB/D/8H RFgJVcC1sdBxVIe/RI4PAqtHMRIG3Jo= X-Google-Smtp-Source: AGHT+IHqmy+36g0qoy8K/BFpuOYCMc9SOfA2of7vLtDy4TUKnQqR4EKq2nuEKOCZV2zSS5xTlzT7+A== X-Received: by 2002:a05:6214:1c4e:b0:680:d233:9d7 with SMTP id if14-20020a0562141c4e00b00680d23309d7mr6609905qvb.125.1704763073119; Mon, 08 Jan 2024 17:17:53 -0800 (PST) Received: from hurd (dsl-205-151-56-231.b2b2c.ca. [205.151.56.231]) by smtp.gmail.com with ESMTPSA id fe5-20020a0562140b8500b0067f90426698sm461339qvb.23.2024.01.08.17.17.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 08 Jan 2024 17:17:52 -0800 (PST) From: Maxim Cournoyer In-Reply-To: <87eder3f9t.fsf_-_@gnu.org> ("Ludovic =?UTF-8?Q?Court=C3=A8s?="'s message of "Mon, 08 Jan 2024 18:29:18 +0100") References: <87eder3f9t.fsf_-_@gnu.org> Date: Mon, 08 Jan 2024 20:17:51 -0500 Message-ID: <87h6jnxq2o.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) 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 X-Migadu-Spam-Score: -5.21 X-Spam-Score: -5.21 X-Migadu-Queue-Id: D759D678A0 X-Migadu-Scanner: mx12.migadu.com X-TUID: rqVh+wiY3/Yt Hi Ludovic! Ludovic Court=C3=A8s writes: > Maxim Cournoyer skribis: > >> The aim is to improve the efficiency of computing the man pages database, >> which must decompress the man pages. Zstd is faster than gzip, especial= ly for >> decompression, and has a similar compression ratio. >> >> * gnu/packages/commencement.scm (%final-inputs): Add zstd. >> * guix/build/gnu-build-system.scm >> (compress-documentation) Update doc. >> >> : New arguments. >> : Rename argument to... >> : ... this. Add an 'extension' argument= to >> the retarget-symlink nested procedure. Use new arguments in nested >> 'maybe-compress' procedure. >> >> Change-Id: Ibaad4658f8e5151633714d263d9198f56d255020 > > That=E2=80=99s a great idea, LGTM! Thank you for the review! > Do you have figures on the space savings of a package with many man > pages such as gnutls:doc or openssl:doc? Surprisingly, all of these I've checked used the weighed the same. Here's gnutls:doc from my local (master) Guix: --8<---------------cut here---------------start------------->8--- $ du -sh /gnu/store/8i3bas6lhziqi2n5wg6qzzhlddkb502c-gnutls-3.7.7-doc 4,9M /gnu/store/8i3bas6lhziqi2n5wg6qzzhlddkb502c-gnutls-3.7.7-doc --8<---------------cut here---------------end--------------->8--- Compared to core-updates with these changes: --8<---------------cut here---------------start------------->8--- $ du -sh /gnu/store/h3lbj1g64lkn9rd9xp86dphqnblxqkl6-gnutls-3.8.1-doc 4.9M /gnu/store/h3lbj1g64lkn9rd9xp86dphqnblxqkl6-gnutls-3.8.1-doc --8<---------------cut here---------------end--------------->8--- That's because all the compressed man pages appear to fit in the minimal 4 KiB size of a single file, whether they are compressed with gzip or zstd compressed. Both man-pages packages weigh 11 MiB, but we can get an idea of the compression ratio using: With my local Guix: --8<---------------cut here---------------start------------->8--- $ find $(guix build man-pages) -name '*.gz' | xargs -n1 du | sort -rn | hea= d -n20 64 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man5/proc.5.gz 44 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/bpf-helpers.7.gz 32 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/perf_event_open.2.gz 28 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/ptrace.2.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/tcp.7.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/cgroups.7.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/seccomp_unotify.2.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/prctl.2.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/open.2.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/futex.2.gz 20 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/fcntl.2.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/user_namespaces.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/socket.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/man-pages.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/ip.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/cpuset.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man7/capabilities.7.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man5/elf.5.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/seccomp.2.gz 16 /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02/share/ma= n/man2/keyctl.2.gz --8<---------------cut here---------------end--------------->8--- On core-updates with these changes: --8<---------------cut here---------------start------------->8--- $ find /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02 -name '*.= zst' | xargs -n1 du | sort -rn | head -n20 56 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man5/proc.5.zst 36 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/bpf-helpers.7.zst 28 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/perf_event_open.2.zst 24 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/ptrace.2.zst 20 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/tcp.7.zst 20 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/seccomp_unotify.2.zst 20 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/prctl.2.zst 20 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/futex.2.zst 20 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/fcntl.2.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/user_namespaces.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/man-pages.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/ip.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/cpuset.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/cgroups.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man7/capabilities.7.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man5/elf.5.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/seccomp.2.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/open.2.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/keyctl.2.zst 16 /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02/share/ma= n/man2/clone.2.zst --8<---------------cut here---------------end--------------->8--- So for larger man pages, it seems we're talking about a 10% improvement. That's not much, but the decompression is more efficient: Compare gzipped man-pages decompression: --8<---------------cut here---------------start------------->8--- $ find /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02 -name '*.= gz' | sh -c 'time xargs gunzip -ck > /dev/null' real 0m0.137s user 0m0.106s sys 0m0.032s $ find /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02 -name '*.= gz' | sh -c 'time xargs gunzip -ck > /dev/null' real 0m0.137s user 0m0.104s sys 0m0.035s $ find /gnu/store/93fjc9hv5canvs2lpya0qsbcm44hq7hh-man-pages-6.02 -name '*.= gz' | sh -c 'time xargs gunzip -ck > /dev/null' real 0m0.138s user 0m0.103s sys 0m0.036s --8<---------------cut here---------------end--------------->8--- With zstd' man-pages decompression: --8<---------------cut here---------------start------------->8--- $ find /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02 -name '*.= zst' | sh -c 'time xargs zstd -dkc > /dev/null' real 0m0.091s user 0m0.033s sys 0m0.059s $ find /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02 -name '*.= zst' | sh -c 'time xargs zstd -dkc > /dev/null' real 0m0.091s user 0m0.035s sys 0m0.058s $ find /gnu/store/nqp5mmi1kb4xp7nkqsybrp5i18lygsl2-man-pages-6.02 -name '*.= zst' | sh -c 'time xargs zstd -dkc > /dev/null' real 0m0.090s user 0m0.027s sys 0m0.063s --8<---------------cut here---------------end--------------->8--- Assuming guile-zstd fares as well as zstd itself, we're looking at 1.5x faster decompression. Past measurements though had suggested the decompression was not the limiting thing in making man-pages faster; rather it had to do with building the database with Guile (sorry, I can't find a reference to it anymore). --=20 Thanks, Maxim