From patchwork Mon Nov 1 09:45:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Xinglu Chen X-Patchwork-Id: 34197 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 7FFFC27BBE3; Mon, 1 Nov 2021 09:47:11 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,T_DKIM_INVALID, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 3769D27BBE1 for ; Mon, 1 Nov 2021 09:47:11 +0000 (GMT) Received: from localhost ([::1]:57764 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mhTuI-0001MX-Ab for patchwork@mira.cbaines.net; Mon, 01 Nov 2021 05:47:10 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53026) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mhTuC-0001MO-1Y for guix-patches@gnu.org; Mon, 01 Nov 2021 05:47:04 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:50419) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mhTuA-0005Cy-9A for guix-patches@gnu.org; Mon, 01 Nov 2021 05:47:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mhTuA-0000Ec-7f for guix-patches@gnu.org; Mon, 01 Nov 2021 05:47:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#51543] [PATCH 2/2] doc: Document =?utf-8?b?4oCYaG9tZS1iYXNo?= =?utf-8?b?LWV4dGVuc2lvbuKAmQ==?= configuration record. Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 01 Nov 2021 09:47:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 51543 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 51543@debbugs.gnu.org Received: via spool by 51543-submit@debbugs.gnu.org id=B51543.1635759962816 (code B ref 51543); Mon, 01 Nov 2021 09:47:02 +0000 Received: (at 51543) by debbugs.gnu.org; 1 Nov 2021 09:46:02 +0000 Received: from localhost ([127.0.0.1]:33732 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mhTtC-0000Cz-6i for submit@debbugs.gnu.org; Mon, 01 Nov 2021 05:46:02 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:58052 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mhTt9-0000CT-Ts for 51543@debbugs.gnu.org; Mon, 01 Nov 2021 05:46:00 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1635759954; bh=+71Bg1Xx4QPpgh8bQQTqrzvtJy1zVPyYARoenLbfqr8=; h=From:To:Subject:In-Reply-To:References:Date; b=YghpnZ7DFovn62j7db9TWVdDxmEcLFTLCH/0NHikIKHF6roW4qey2cjJWZ+nYom2I mMeXFDs6i5jehxoH2KA5jVO7AOWUkD6g8l5VzPRGP1QZbcvlw8iv3KVMdN9gNgMHL8 aUS/n2q+s72nNJAM0ZOqaP/G/pcxcNOitovuoWmk= In-Reply-To: References: Message-Id: Date: Mon, 01 Nov 2021 10:45:53 +0100 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 (Shells Home Services): Document ‘home-bash-extension’ configuration record. * gnu/home/services/shells.scm (generate-home-bash-documentation): Extract docstrings from ‘home-bash-extension’. Fixes: --- doc/guix.texi | 24 ++++++++++++++++++++++++ gnu/home/services/shells.scm | 14 ++++++++++---- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index f7312a5b30..a3b440f5c9 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -36206,7 +36206,31 @@ process for example). @end table +@end deftp + +To extend the Bash service, one has to use a @code{home-bash-extension}, +which contains mostly the same fields as @code{home-bash-configuration}. + +@deftp {Data Type} home-bash-extension +Available @code{home-bash-extension} fields are: + +@table @asis +@item @code{environment-variables} (default: @code{()}) (type: alist) +Association list of environment variables to set. + +@item @code{aliases} (default: @code{()}) (type: alist) +Association list of aliases to set. +@item @code{bash-profile} (default: @code{()}) (type: text-config) +List of file-like objects. + +@item @code{bashrc} (default: @code{()}) (type: text-config) +List of file-like objects. + +@item @code{bash-logout} (default: @code{()}) (type: text-config) +List of file-like objects. + +@end table @end deftp @subsubheading Zsh Home Service diff --git a/gnu/home/services/shells.scm b/gnu/home/services/shells.scm index bd1595a041..9eeb7153e3 100644 --- a/gnu/home/services/shells.scm +++ b/gnu/home/services/shells.scm @@ -648,10 +648,16 @@ (define (generate-home-shell-profile-documentation) 'home-shell-profile-configuration)) (define (generate-home-bash-documentation) - (generate-documentation - `((home-bash-configuration - ,home-bash-configuration-fields)) - 'home-bash-configuration)) + (string-append + (generate-documentation + `((home-bash-configuration + ,home-bash-configuration-fields)) + 'home-bash-configuration) + "\n\n" + (generate-documentation + `((home-bash-extension + ,home-bash-extension-fields)) + 'home-bash-extension))) (define (generate-home-zsh-documentation) (generate-documentation