From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:403:4876::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id gInFJoVypWUOagEAe85BDQ:P1 (envelope-from ) for ; Mon, 15 Jan 2024 18:59:33 +0100 Received: from aspmx1.migadu.com ([2001:41d0:403:4876::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id gInFJoVypWUOagEAe85BDQ (envelope-from ) for ; Mon, 15 Jan 2024 18:59:33 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=e3o5DpOv; arc=pass ("zohomail.com:s=zohoarc:i=1"); dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1705341200; 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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=ySBZfMfBG2wOvq4LysME9o1Jy5VIO/Kyd6tHQi1RWdk=; b=LM+enhbA4rLxDW7O1jqJe55+9042xwG6nBFKhfG9XhPp0b4XMXjuDPf9GDjxqpFRsiJKzp 2SdWoxmGgKZ+/X9zvMxZ4Fjvs/jIUA862AXoB8FtjCGgUs4fQU6BFVLUl9f0L1wusNesJm AY+NIvmojLew4+hSV5BlVzuczDf3mQYEXpeKQ+jMPeifoeUzgqwGO65oqeUki0FaVK+TEn ywhhIGC2I3O9H5+P19T7vXBl0/BxLVRIKykWKYa8VYWczPKG/MU+0nBUYsZweEU9tz0lcI /TlkcZEwTfc8qmMgGArXLT2UevZrpfKfb1JPXl7r7iKUamC3XDuNCu3Gplt0UA== ARC-Seal: i=2; s=key1; d=yhetil.org; t=1705341200; a=rsa-sha256; cv=pass; b=EWoNB4WaU57TqAYCxgxxT9eMkEc9kHoYQo0WtDHXn1LQVP6AEoVaoWOMKL+ap670RquYj7 YJ1hXJl0hJIU9koNpZQRDi3rdfdN9vjTZtwUUjRyzi59cGUeEZnYQSUTfUSSPCCK8XOjzC spOkG88hk7O5vDdFhpmVv7AOqUwjNBQoFnLXrU8r9QAcEhkqiOKrZS8vJHfC88tzjQfQX9 i+WbJyoLkk0hTZYz3yLyuda3Zz4BFhmPXREtoBbf3jG03jwr4zfj/+tic2xuaaRNIylskj FJBB9OExK/wsQ3DhhhX+UM2IQkUWmVRvNKFVakqwAgaGGhWiL7tk2SVzI+sYqQ== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=e3o5DpOv; arc=pass ("zohomail.com:s=zohoarc:i=1"); dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" 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 F281776606 for ; Mon, 15 Jan 2024 18:53:19 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rPR8n-0007OD-Oj; Mon, 15 Jan 2024 12:52:53 -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 1rPR8j-0007Nx-So for guix-devel@gnu.org; Mon, 15 Jan 2024 12:52:50 -0500 Received: from sender4-op-o10.zoho.com ([136.143.188.10]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rPR8h-0001oi-V3 for guix-devel@gnu.org; Mon, 15 Jan 2024 12:52:49 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1705341160; cv=none; d=zohomail.com; s=zohoarc; b=mz8jnSgh/I5yKaECimgnZCELRP5G3usyYu3ai3vaD1dX9rljgSZVqRLAcFI6yXWRfqXqfH6EKmZ2IcPkRBBdAosxs2/wP9IA75ZROen29rXDe79SPwKLalpKyVh3KxZWRIn0HKhWxLJDfTQxCmtYSXi2GRZkbo6sb3t3huvvHR0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705341160; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=ySBZfMfBG2wOvq4LysME9o1Jy5VIO/Kyd6tHQi1RWdk=; b=F1mahp4gOo8b2jHovhNcsM3MrVOBmj5Yd+IbotYjQ4o0vZgtclW0iqky69khtnftlGg6piwDAYEuuGQUFPJfvA4PZfBe75phSBNvQd6TTPseJ7kCHDhYojQBbe12sLYtRWaHR4uCWvQldNYLPC9z60LY/++y5IsPysUmFqY31Q0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1705341160; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Cc:Cc:Message-ID:In-Reply-To:References:Subject:Subject:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Reply-To; bh=ySBZfMfBG2wOvq4LysME9o1Jy5VIO/Kyd6tHQi1RWdk=; b=e3o5DpOv0dR94lId1Axvgb9+WsQYIgyV5jN6n46VmkU5lVexKA1VL6smUjECMFX6 0WanH/6kqGJhc+kxDYI40c2Es6OzcCzZbCu4o6Kcah1iaE44AqghciQPl8KdEcRkWE+ 6j711LkoVYUekvM3p67xqIYng1GdqDH+IFfCYdBo= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1705341157659952.1791840203342; Mon, 15 Jan 2024 09:52:37 -0800 (PST) Date: Mon, 15 Jan 2024 18:52:37 +0100 From: Matt To: "Christian Miller" Cc: "guix-devel" Message-ID: <18d0e410102.e16898001715108.8020629039859398477@excalamus.com> In-Reply-To: <87a5p8yn4p.fsf@dadoes.de> References: <87a5p8yn4p.fsf@dadoes.de> Subject: Re: Feedback of the GNU Guix manual MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail Received-SPF: pass client-ip=136.143.188.10; envelope-from=matt@excalamus.com; helo=sender4-op-o10.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: guix-devel-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Scanner: mx10.migadu.com X-Migadu-Spam-Score: -8.85 X-Spam-Score: -8.85 X-Migadu-Queue-Id: F281776606 X-TUID: SyqZzBNSDQdU I care about this. How can I help? - Convert the notes into patches? - Proofread any patches that derive from Christian's efforts? =20 ---- On Sun, 14 Jan 2024 16:01:58 +0100 Christian Miller wrote ---=20 > I read through the GNU Guix manual on revision > ee7c9d254117fa470686210ad2ef5e7f1ba4fefc with Emacs in TTY mode. What's TTY mode? M-x tty reveals nothing for me. =20 > As a beginner, the manual was helpful and I learned lot's of stuff. > Though it felt heartless. No consistency and sometimes the structure > is confusing (especially the contributing part, since it tries to get > GNU Guix System and GNU Guix under one section and it was kinda > confusing for me). Thank you for sharing your experience. I'm sorry it wasn't more positive. = I've found it challenging to read as well. > It seems that there is no style guide. Sometimes default values are > mentioned and sometimes not. Also some use uppercase and other use > lowercase for type of variable. There is also Scheme code which is > most of the time in the old style notation. For me as a beginner, > this was confusing. The GNU project has several: - https://www.gnu.org/prep/standards/html_node/Documentation.html - https://www.fsf.org/licensing/gnu-press/GNU-Press-styleguide.pdf > I will mention lot's of style issues since at that time I did not know > it is in such a bad state. I respectfully disagree that it's in bad taste to mention them. I find suc= h feedback helpful towards correcting the problems you experience. I appre= ciate you taking the time to write them all up. It's nice to know someone = reads the manual! :) -- Matt Trzcinski Emacs Org contributor (ob-shell) Learn more about Org mode at https://orgmode.org Support Org development at=C2=A0https://liberapay.com/org-mode