From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id QGV8GkXqf2EymwAAgWs5BA (envelope-from ) for ; Mon, 01 Nov 2021 14:23:17 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id 6K0wFkXqf2EBKwAA1q6Kng (envelope-from ) for ; Mon, 01 Nov 2021 13:23:17 +0000 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 B640210B64 for ; Mon, 1 Nov 2021 14:23:16 +0100 (CET) Received: from localhost ([::1]:36482 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mhXHP-0004sf-Sm for larch@yhetil.org; Mon, 01 Nov 2021 09:23:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:56770) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mhXHD-0004nx-A8 for guix-patches@gnu.org; Mon, 01 Nov 2021 09:23:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:50694) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mhXHD-0004tF-1p for guix-patches@gnu.org; Mon, 01 Nov 2021 09:23:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mhXHC-0008BY-Ct for guix-patches@gnu.org; Mon, 01 Nov 2021 09:23:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#51543] [PATCH 2/2] doc: Document =?UTF-8?Q?=E2=80=98home-bash-extension=E2=80=99?= configuration record. Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 01 Nov 2021 13:23: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: Liliana Marie Prikler , 51543@debbugs.gnu.org Received: via spool by 51543-submit@debbugs.gnu.org id=B51543.163577293231382 (code B ref 51543); Mon, 01 Nov 2021 13:23:02 +0000 Received: (at 51543) by debbugs.gnu.org; 1 Nov 2021 13:22:12 +0000 Received: from localhost ([127.0.0.1]:34007 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mhXGO-0008A5-8K for submit@debbugs.gnu.org; Mon, 01 Nov 2021 09:22:12 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:36338 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mhXGM-00089p-V9 for 51543@debbugs.gnu.org; Mon, 01 Nov 2021 09:22:11 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1635772922; bh=uJ2s5d5HgWov099g2YQoT81ljzKMnhd6JPVvF49nxVE=; h=From:To:Subject:In-Reply-To:References:Date; b=F9lWx4V3Ei+ICNLh0BvcZDoL0OdaF+y8bM2T5jmrMvuErYBPnmiWIQsUQfA5Q3gfd +XVh7ICWMI4XuTkHUAgmf55zkZRpTs202G5VX3FRGB/4kLcvra4umntcMLLxBwlswm TtCtAA+i7D+ePu1Rdrsr+5XAe5NYVai9XWNZEdfQ= In-Reply-To: <8624d1b4164dd14846362d66005552705064de96.camel@gmail.com> References: <8624d1b4164dd14846362d66005552705064de96.camel@gmail.com> Date: Mon, 01 Nov 2021 14:22:01 +0100 Message-ID: <87k0hs57uu.fsf@disroot.org> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" 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 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1635772997; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: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: dkim-signature; bh=I+nW1EQ7tFh88kuxxX13cLCI9dW23Q8JSgbVaNRehas=; b=mJOzg0RpmzwoB758+Z9mwMaPQEG03hD43LraArhR77Skv+473CznXrv8CbCQBQSfS32WBL xG6yHGgMEBUTEwzYpZwjs/rGai/vGks/gAhMVPCR8zPHExyUgHPAsDNpQObYw8qy2iMPoc 2rPgT3d2Gz8zy4TQDeNM3qGPG/xH40oSXaodgii/OwR3Do7xTJf4chRs4fZVMMwT9CA/ve kzSuHzgQIOzZWg+rbjaGWXlO4DJNY4Uwl9pqupBNaI038MP8JisyF5rAy+T+fMACOI9bia C8qTMAeZlWQ3r0L/D5/Z6BtFYijeMDTKpH+SZA6Nh0+GUXcyQ/a+GjeYBQwYVA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1635772997; a=rsa-sha256; cv=none; b=FOnW+xEpsrKrlTZqZDv+KIFUHJzZ5f0IA1+JgDudgGesF5i3FtRkw1F8q4Tnz3ONx8Fj9r DAgE/PzFtocRsykPWWYd6w7q2QvvFqO3Rbd6eW4Joj2qZXzBEdTIp2upIgKWmL9Uk776Zs lHfn5N1Y5CVzRCXA+8hU10ZZGTv/h3Hz6MeeT1L37ffirzAsZL673EnIoJXxDnu8kQf5nx Kf/5uslykVHQBOpXWwwIx7BuJOd3KPi8iIgHnlkZLIjyD4gwQMvl2KZDA/+ZccjCN2pBKi TOYbW4nHVffi/VQLhMPIRrTeypDXjxWOSBxkCG+L4QIqMuNanlO1Nh+5f7iHMA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=F9lWx4V3; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Spam-Score: -3.42 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=F9lWx4V3; dmarc=fail reason="SPF not aligned (relaxed)" header.from=yoctocell.xyz (policy=none); spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Queue-Id: B640210B64 X-Spam-Score: -3.42 X-Migadu-Scanner: scn0.migadu.com X-TUID: zYCvT6NUx4u+ --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hi, On Mon, Nov 01 2021, Liliana Marie Prikler wrote: > Hi, > > Am Montag, den 01.11.2021, 10:45 +0100 schrieb Xinglu Chen: >> * doc/guix.texi (Shells Home Services): Document =E2=80=98home-bash- >> extension=E2=80=99 >> configuration record. >> * gnu/home/services/shells.scm (generate-home-bash-documentation): >> Extract >> docstrings from =E2=80=98home-bash-extension=E2=80=99. >>=20 >> Fixes: >> --- >> doc/guix.texi | 24 ++++++++++++++++++++++++ >> gnu/home/services/shells.scm | 14 ++++++++++---- >> 2 files changed, 34 insertions(+), 4 deletions(-) >>=20 >> 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). >>=20=20 >> @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}. > This sounds like you're forcing people to extend their services. Write > it "You can extend the bash service by using home-bash-extension, whose > fields mostly mirror that of home-bash-service". Indeed, that sounds better. >> +@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. >>=20=20 >> +@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 > This documentation is a little sparse, don't you agree? Are the keys > to environment-variables strings or symbols? The keys should be strings; the rules for =E2=80=98home-environment-variable-service-type=E2=80=99 apply here (see = =E2=80=9C11.3.1 Essential Home Services=E2=80=9D). > At which point are these fields inserted into which files (e.g. do the > aliases come before profile or after it)? Good question! The contents of =E2=80=98aliases=E2=80=99 and =E2=80=98bash= rc=E2=80=99 are put into ~/.bashrc, in that order. The contents of =E2=80=98bash-profile=E2=80=99 a= nd =E2=80=98environment-variables=E2=80=99 are put into ~/.bash_profile, in th= at order. This doesn=E2=80=99t seem that consistent, is there any preference to what = order should be used? > If some field is already described as part of home-bash-service, you > might also want to link back to it, but you should still state where > the extension occurs. Is new code added to the front or to the back > for instance. (On that note, is the text-config type > well-documented?) I don=E2=80=99t think there is a way to link to =E2=80=98home-bash-configur= ation=E2=80=99 using Texinfo; one can only link to =E2=80=9CShells Home Services=E2=80=9D. --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJJBAEBCAAzFiEEAVhh4yyK5+SEykIzrPUJmaL7XHkFAmF/6fkVHHB1YmxpY0B5 b2N0b2NlbGwueHl6AAoJEKz1CZmi+1x5MZ0P/0FcR1Mhify/gFakPR7+0yyZpIAr hYWr1JyM/qfMXIN7MJjtGM8Fxi7FRYXT/mBjoxvl1shtHeJv1dU3i44g9nl+T+1f ydnbUS3SMcWYYIGI2ZDkNVoE1yfL9ogvm9sX1k5EFyWwNysBkgCyVDuWfHLWhF8v fj2C82r91mdFb5VEw/l1Yj1AhJ3PYEAuJ6Tb6s23UfkLb2oZsbug9+suJR92R72s G3P5hdoM+YdvJk4L84nKOakXRq//uNTy8WOzZ+q/WUm+Zu1+TRHHkkFRz1D1uUnY d+KxzzucsLEcmBMtW3HRddzlsrrt5J6l/Dx9Cfrh9kY4z947ClWObSb4S1T3Eon0 lAnsQOoO4JFygjcyuiGosITo/0HZJuEuGuHSO/gdZiFqrnpdb3CMl6kdbo32tXEj lfFgdvVEgaQ+jHB86rsE3crbuvT0v6cP4+ltbx8FtTp3BgBoLvvIn+P8mQFLxYJ9 Kb8t02hXfwE7wJw7UM9cAse2RtmjlWPefROYONaAU/Koy8ABJsm29GIzDpPNe2JM RlhBMzXPZypA+wjOg1kDqsnboTDPEqYLspdro8hFxBdUD7cOqXajPrgrrh0G0L0y Y+ZN6A4w0lkdTPLJ1nJeMjVp1fc60v/ryaUuClOix35gpJ+aO+YKJP4HI2f6CifM U/p74e+AKf+Kj88Q =fJwV -----END PGP SIGNATURE----- --=-=-=--