From patchwork Sun May 8 15:29:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Liliana Marie Prikler X-Patchwork-Id: 39157 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id F0C6827BBEA; Sun, 8 May 2022 16:37:13 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 8A4D227BBE9 for ; Sun, 8 May 2022 16:37:13 +0100 (BST) Received: from localhost ([::1]:56236 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nniy8-00025T-MU for patchwork@mira.cbaines.net; Sun, 08 May 2022 11:37:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58304) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nnixy-00024u-S9 for guix-patches@gnu.org; Sun, 08 May 2022 11:37:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:32921) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nnixy-0006g9-Jn for guix-patches@gnu.org; Sun, 08 May 2022 11:37:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nnixy-0007nk-Fk for guix-patches@gnu.org; Sun, 08 May 2022 11:37:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#55317] [PATCH] doc: Clarify guix shell's DWIM behaviour. Resent-From: Liliana Marie Prikler Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 08 May 2022 15:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 55317 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 55317@debbugs.gnu.org Cc: Ryan Prior X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.165202420129957 (code B ref -1); Sun, 08 May 2022 15:37:02 +0000 Received: (at submit) by debbugs.gnu.org; 8 May 2022 15:36:41 +0000 Received: from localhost ([127.0.0.1]:55050 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nnixc-0007n7-SM for submit@debbugs.gnu.org; Sun, 08 May 2022 11:36:41 -0400 Received: from lists.gnu.org ([209.51.188.17]:37064) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nnixb-0007n0-Hg for submit@debbugs.gnu.org; Sun, 08 May 2022 11:36:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58230) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nnixb-000229-AQ for guix-patches@gnu.org; Sun, 08 May 2022 11:36:39 -0400 Received: from mail-ej1-x644.google.com ([2a00:1450:4864:20::644]:35746) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nnixZ-0006Z8-Hk for guix-patches@gnu.org; Sun, 08 May 2022 11:36:39 -0400 Received: by mail-ej1-x644.google.com with SMTP id ks9so16144033ejb.2 for ; Sun, 08 May 2022 08:36:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:date:subject:to:cc:content-transfer-encoding:message-id :mime-version; bh=I/P/osEOKBJLFtf/DPeS8MIsunaMhD3oFJi8kFgMkZ4=; b=CNq6oHXb5yCy1bpIWTXrpSrfUCqvJ8MmBoCK1T+p+j9kqrhwC6HYq6pyY8A5LzRfiO pS4G/MCxs4ZCWEjBxokz0ihwFdjahkLbtfQU/24trUqsSrxOI+1jgdKg5hJU1laI8L5N xCwWH3B6AA2Zp5lcmKjTt6NPwoJK4gOTYqVEOthdAkg9XnBWoFOdjai25JkcSJp7sSVU VUcY/yKDqukCyNVS7amlWBFYvCl+h030tWHpU1tMq8lZRp3r4b2nNTomkF76f324I4wS kfc8aXUr0b3jvddgxjd42ekRN7ZsdFNYH6IQExzm04j203FxVVU5dAhHrb8ZP3zpjQ3B CLXQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:date:subject:to:cc :content-transfer-encoding:message-id:mime-version; bh=I/P/osEOKBJLFtf/DPeS8MIsunaMhD3oFJi8kFgMkZ4=; b=i8nIDz+/kcTjry01SJYeREdshW1pT9GIjZX9xpx9OkcGPTQOfkj3dt3LAoIDz2kOt5 DFA5noxTI61yAlFHX8WdwqAvGXH4T9SBAjwxtRNo07Or/lcZq7yMTmvRXTHV17ZrUVnP wa0qUPwwRjQRRgoP2VRKnBYcaB4bahBAtkPFaSf7kgGIRRfUCzh5JVPssQLAUalMdnno qf4Zsf/MiDpdroTSrETIATv8FX3mavajvQn7oDMsTf25jA1jKE5qapbsn/VZOo+FmGe/ SljU1/6onMv0S2RgBk7ZM6pWqwK2RpRa+6xBtH3U0M5NrpaJ91VuP8hqxqjuF3RbOp4M Kajg== X-Gm-Message-State: AOAM5307T5vzPuWFAuhogi5yhNzjj0XVkvoxfsr4y7+1IP8cZ4YFowc3 7PNRI+SAnoaqS1Ndp9T60NmEQuyQBL4= X-Google-Smtp-Source: ABdhPJz89eqUO5OrSIU1D9gbHecf52vpH1uLzg8GMDe4Hgw25j1KJCOQ09Msn6/u/Orin4n4ib+Ilw== X-Received: by 2002:a17:906:4f0f:b0:6f4:667c:ff9d with SMTP id t15-20020a1709064f0f00b006f4667cff9dmr11528691eju.519.1652024195690; Sun, 08 May 2022 08:36:35 -0700 (PDT) Received: from nijino.fritz.box (85-127-52-93.dsl.dynamic.surfer.at. [85.127.52.93]) by smtp.gmail.com with ESMTPSA id pj9-20020a170906d78900b006f39ffe23fdsm4173644ejb.0.2022.05.08.08.36.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 08 May 2022 08:36:35 -0700 (PDT) From: Liliana Marie Prikler Date: Sun, 8 May 2022 17:29:06 +0200 Message-ID: <9184428ce5f7de56848b1c0018b2639dd0e8a5ca.camel@gmail.com> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::644; envelope-from=liliana.prikler@gmail.com; helo=mail-ej1-x644.google.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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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: 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+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches --- Bonjour Guix, as can be seen from , the way in which guix shell interactively does what you mean is open to interpretation and different folks may mean different things when specifying nothing. Therefore, document guix' assumptions more clearly. Cheers doc/guix.texi | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 5399584cb0..249c5956e2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -5693,17 +5693,16 @@ before @command{guix shell} was invoked. The next garbage collection (@pxref{Invoking guix gc}) may clean up packages that were installed in the environment and that are no longer used outside of it. -As an added convenience, when running from a directory that contains a -@file{manifest.scm} or a @file{guix.scm} file (in this order), possibly -in a parent directory, @command{guix shell} automatically loads the -file---provided the directory is listed in -@file{~/.config/guix/shell-authorized-directories}, and only for -interactive use: - -@example -guix shell -@end example - +As an added convenience, @command{guix shell} when invoked interactively +without any other arguments will try to do what you mean based on the +files it locates in the current directory or parent directories. +If it finds a @file{manifest.scm}, it uses this manifest as though +it was given via @code{--manifest}. +If it finds a @file{guix.scm}, it uses this package file as though +it was given via @code{--development --file}. +In either case, the file will only be loaded if the directory it +resides in is listed in +@file{~/.config/guix/shell-authorized-directories}. This provides an easy way to define, share, and enter development environments.