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: 39255 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 B8F8627BBE9; Sat, 14 May 2022 13:05:34 +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=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI,T_SPF_HELO_TEMPERROR 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 EB07027BBEA for ; Sat, 14 May 2022 13:05:21 +0100 (BST) Received: from localhost ([::1]:56650 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1npqWF-0007de-1O for patchwork@mira.cbaines.net; Sat, 14 May 2022 08:05:11 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43396) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1npqW7-0007b1-3F for guix-patches@gnu.org; Sat, 14 May 2022 08:05:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:52048) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1npqW6-00088l-Pb for guix-patches@gnu.org; Sat, 14 May 2022 08:05:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1npqW6-0004Rc-JV for guix-patches@gnu.org; Sat, 14 May 2022 08:05:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#55317] [PATCH v2] doc: Clarify guix shell's DWIM behaviour. References: <9184428ce5f7de56848b1c0018b2639dd0e8a5ca.camel@gmail.com> In-Reply-To: <9184428ce5f7de56848b1c0018b2639dd0e8a5ca.camel@gmail.com> Resent-From: Liliana Marie Prikler Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 14 May 2022 12:05:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55317 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Ludovic =?utf-8?q?Court=C3=A8s?= Cc: 55317@debbugs.gnu.org, Ryan Prior Received: via spool by 55317-submit@debbugs.gnu.org id=B55317.165252988617050 (code B ref 55317); Sat, 14 May 2022 12:05:02 +0000 Received: (at 55317) by debbugs.gnu.org; 14 May 2022 12:04:46 +0000 Received: from localhost ([127.0.0.1]:45945 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1npqVp-0004Qw-RD for submit@debbugs.gnu.org; Sat, 14 May 2022 08:04:46 -0400 Received: from mail-ed1-f66.google.com ([209.85.208.66]:41956) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1npqVn-0004Qd-OC for 55317@debbugs.gnu.org; Sat, 14 May 2022 08:04:44 -0400 Received: by mail-ed1-f66.google.com with SMTP id d6so12842773ede.8 for <55317@debbugs.gnu.org>; Sat, 14 May 2022 05:04:43 -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=zFZ1tqGlblZsUsMuCVdPab8LxoQCfhGYOvCsxO0swLE=; b=CGLpxB5FLwx+00Xgo0mwEyFjtsgLe8X2dp7v8vjX//JbjViBVZYnf9ZRdGX8g2UxSE kJFNkRwq26agrljhRH64j6UcLETUBtdV4VmiaMIWmqz7jb+GlBzMz1hmaT7hJAQk4m7Y VaFsFQXo1KOli2NmCp2gW5+ZVjp60+oU7lr/rC5pUSA3mTQnTRUoEgAsKxGZOOTj78OO mxLI73K45fk8szk6o0y1xnhV1p5ngAFugDMtB/tTiTCCnDFPkCQ/NoT34OgQdz8khGMd kMHfZE0yFG3Zcql4ma9Kj+rgTQdKhux2PzgaY6cIpRymUf4NYV8K7KZdLSud3dJEYmlj kVyQ== 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=zFZ1tqGlblZsUsMuCVdPab8LxoQCfhGYOvCsxO0swLE=; b=Lpt1Tv/vJtP3tLwmgJZFem4v7NUAkYoXrvRtKtxWmJ9onW6sH2Hg+TCkaFjvuq1Xws G6gUXOzZweC9PrCpEjnmqzikxmBeX1pJAQuvNGEAzma0jWBPnpQscli5HfMIpR/FHTJe sQOs4oRpwQ+VXBxI49NcZh5bGOE1RUVgYFMjo3nQ0/NWN7To6+6kB75gBa9sxdZE71se xovdqJiRBRKGhNFG/17C1kSYFUr9KxrHZ5L5F+Io0yD7+CpNFgHBL6PNW848clHdrc3u PjUL1AIj449+6AORobunkCvVdsC0Xpk0cFGKqMC0glS4lFN5ZS4waVA24CLH8u4rhKZ3 dKkg== X-Gm-Message-State: AOAM533c/BIq0yaxn/ZMVWh4c+Yat6Q6KZplBX0BptVc0+5LH6GJIjFg fUG8rKiW1ZIAIi6GvB3LqTM= X-Google-Smtp-Source: ABdhPJyAs1tZHPGAky6vMj1QH0Mh+ZLLOYA7OG0lUXdsgeE3sVuxH0PemAHghuei90jwQkiVCO/p7Q== X-Received: by 2002:aa7:d4d4:0:b0:427:5f6:c5d0 with SMTP id t20-20020aa7d4d4000000b0042705f6c5d0mr3512034edr.207.1652529877882; Sat, 14 May 2022 05:04:37 -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 el9-20020a170907284900b006f3ef214e22sm1655154ejc.136.2022.05.14.05.04.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 14 May 2022 05:04:37 -0700 (PDT) From: Liliana Marie Prikler Date: Sun, 8 May 2022 17:29:06 +0200 Message-ID: <3eccfbb0aa34517d4ff44822c7634872f4528e19.camel@gmail.com> MIME-Version: 1.0 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 * doc/guix.texi ("Invoking guix shell"): Document the exact behaviour, that is which flags go together with which file names. --- doc/guix.texi | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index e1fb50a634..34908462e2 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -5670,17 +5670,20 @@ 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: - +As an added convenience, @command{guix shell} will try to do what you +mean when it is invoked interactively as in @example guix shell @end example - +without any other arguments. If it finds a @file{manifest.scm} in the +current working directory or any of its parents, it uses this manifest +as though it was given via @code{--manifest}. Likewise, if it finds +a @file{guix.scm} in the same directories, it uses it to build a +development profile as though both @code{--development} and @code{--file} +were present. +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.