From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id qIEXHjd/C2KcKgEAgWs5BA (envelope-from ) for ; Tue, 15 Feb 2022 11:23:51 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id mOLXFjd/C2JtmAAAG6o9tA (envelope-from ) for ; Tue, 15 Feb 2022 11:23:51 +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 D4B4D39083 for ; Tue, 15 Feb 2022 11:23:50 +0100 (CET) Received: from localhost ([::1]:54408 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nJuzt-0000Ql-JB for larch@yhetil.org; Tue, 15 Feb 2022 05:23:49 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35078) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nJunW-0004Qd-IL for guix-patches@gnu.org; Tue, 15 Feb 2022 05:11:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:49675) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nJunW-00061Z-8K for guix-patches@gnu.org; Tue, 15 Feb 2022 05:11:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nJunV-0005sw-VU for guix-patches@gnu.org; Tue, 15 Feb 2022 05:11:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53827] [PATCH] Add a TLDR entry to the cookbook for building Guix from Git. Resent-From: Pierre-Henry =?UTF-8?Q?Fr=C3=B6hring?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 15 Feb 2022 10:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 53827 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Ludovic =?UTF-8?Q?Court=C3=A8s?= , Maxime Devos Cc: 53827@debbugs.gnu.org Received: via spool by 53827-submit@debbugs.gnu.org id=B53827.164491983522590 (code B ref 53827); Tue, 15 Feb 2022 10:11:01 +0000 Received: (at 53827) by debbugs.gnu.org; 15 Feb 2022 10:10:35 +0000 Received: from localhost ([127.0.0.1]:43572 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nJun5-0005sH-Bg for submit@debbugs.gnu.org; Tue, 15 Feb 2022 05:10:35 -0500 Received: from relay5-d.mail.gandi.net ([217.70.183.197]:37415) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nJun3-0005s0-94 for 53827@debbugs.gnu.org; Tue, 15 Feb 2022 05:10:34 -0500 Received: (Authenticated sender: contact@phfrohring.com) by mail.gandi.net (Postfix) with ESMTPSA id 9196A1C000D; Tue, 15 Feb 2022 10:10:26 +0000 (UTC) Message-ID: <089df39f323ee4b4bb83b6b7e0cc8f262a9317e5.camel@phfrohring.com> From: Pierre-Henry =?UTF-8?Q?Fr=C3=B6hring?= Date: Tue, 15 Feb 2022 11:10:24 +0100 In-Reply-To: <8735kkqydy.fsf_-_@gnu.org> References: <20220206213344.3117861-1-contact@phfrohring.com> <2c51e2236116c55e112199a2dbfb143361e88ae8.camel@telenet.be> <8735kkqydy.fsf_-_@gnu.org> Content-Type: text/plain; charset="UTF-8" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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" 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=1644920630; 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; bh=jWrFW/H8NVNOOrKb74tTuXZSe/aqlJ11r3vJrs5Qh4Y=; b=tQ0PITXv2x+eh2C6bczIeQxGLfGFe2qbLXBoyj7yVgjnqBm7EUW+sQgW1yPN9159M/3BSf qooer93UYrZUm9HK1enba8NhMdda/O8OhpjvfBfriHFQpnpsxK84AL6ueUaaTmKQ32KP++ xxURk5UvXDrKQG4fCgDUcvhQ4zPbnf9gX6aIJnhjFfdNz/zodvUhe/ekbuxVKhlcoLDjNl 1ond9t74SyVoYXskGeaq8YUHW4yihtlZkIM/rf13m1q90FbJ9NnzXHU59d95mXYSCtIGVq kmI0oWvgSDfCmkHae47047jDaM5c772cg+nwMSByIc7wuOxejWnaW9o9FuKJag== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1644920630; a=rsa-sha256; cv=none; b=POAdBlITm30joSQdGcgoWJwUytbTWSvq9+FxVgBJSdI9pUGHptM368anF0nUa3b/qU6fut RBVYxC7eMf3/eNldtSLKqcaRcTPp19mFV9/IoW1jBlLw+iaqWYSIWyXfwVMn/j3xHxI7rC K+lyGcMA8uBxvks63ON0z6zMEd9s20HZY6iRBZVdvdRP1Ih4VOkjIfCjlvTlFowpbFIoqx ufgSKGMN70Di8GJne4+0FEAe4EK1n7QZvx2ZY0ZUGRNxl+7di/GKlO69yM2TqCACwiBdnW 0EVoQJNiQmRgwEG5CWKImsKNf2/jdkuV0+6FVTIaXzyaGdpcQgZezcWvkzoP8Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=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-Migadu-Spam-Score: -3.23 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=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-Migadu-Queue-Id: D4B4D39083 X-Spam-Score: -3.23 X-Migadu-Scanner: scn1.migadu.com X-TUID: ujYg0zzuc5tn Hello Ludovic, I try to make Guix our default package manager. It's really wonderful so far. To that end, I need TLDRs so that less experienced developpers can get going /fast/. Deeper understanding will come in time. I also need to convince that Guix is /easy/ to third parties. I need to /show/ that /installing/, /configuring/ and /using/ Guix is fast and efficient. I found out that TLDRs are great tools for that. I need to have small TLDRs so that when things go wrong, it's easy to know where and fix either the TLDR or the manual steps. Also, sometimes, things go wrong and are not documented. /E.g./ setting ~LC_ALL=C.UTF-8~ will make Guix complain even after installing ~guix install glibc-utf8-locales~. I can factor this knowledge inside these TLDR fast. Now, if I compare the official documentation: https://guix.gnu.org/manual/devel/en/html_node/Building-from-Git.html with the TLDR version of it: https://transient.blog/1/tutoriel-guix-devel/ea10580e-9750-463a-aff4-9a3e90809ad4/54fcc4f606 Then, even after taking into account the great work accomplished in the documentation, I find the TLDR version more convincing. Pierre-Henry On Tue, 2022-02-15 at 10:20 +0100, Ludovic Courtès wrote: > Hi, > > Maxime Devos skribis: > > > Pierre-Henry Fröhring schreef op zo 06-02-2022 om 22:33 [+0100]: > > > +@node Building from Git > > > +@chapter Building from Git > > > + > > > +Build Guix from Git and start hacking. > > > + > > > +@node Context > > > +@section Context > > > > This is all explained in the main manual in more detail, can a > > cross- > > reference to ‘(guix)Building from Git’ be added? > > Yes, I wonder: what do you think Pierre-Henry is wrong with the > same-named section of the manual? > >   > https://guix.gnu.org/manual/devel/en/html_node/Building-from-Git.html > > It is more verbose, but the important commands are in @example boxes, > which should allow the reader to skip straight to the main parts. > > WDYT? > > Ludo’.