From: Xinglu Chen <public@yoctocell.xyz>
To: 51543@debbugs.gnu.org
Subject: [bug#51543] [PATCH 2/2] doc: Document ‘home-bash-extension’ configuration record.
Date: Mon, 01 Nov 2021 10:45:53 +0100 [thread overview]
Message-ID: <a92171a4ae30035432b14550243743c9b675e0a5.1635759705.git.public@yoctocell.xyz> (raw)
In-Reply-To: <cover.1635759704.git.public@yoctocell.xyz>
* 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: <https://issues.guix.gnu.org/50991>
---
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
--
2.33.0
next prev parent reply other threads:[~2021-11-01 9:47 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-01 9:43 [bug#51543] [PATCH 0/2] Some improvements to the Bash home service Xinglu Chen
2021-11-01 9:45 ` [bug#51543] [PATCH 1/2] home: services: bash: Add ‘aliases’ field Xinglu Chen
2021-11-01 9:45 ` Xinglu Chen [this message]
2021-11-01 10:45 ` [bug#51543] [PATCH 2/2] doc: Document ‘home-bash-extension’ configuration record Liliana Marie Prikler
2021-11-01 13:22 ` Xinglu Chen
2021-11-01 16:38 ` Liliana Marie Prikler
2021-11-05 11:56 ` Xinglu Chen
2021-11-05 14:03 ` [bug#51543] [PATCH 0/2] Some improvements to the Bash home service Xinglu Chen
2021-11-05 14:03 ` [bug#51543] [PATCH 1/2] home: services: bash: Add ‘aliases’ field Xinglu Chen
2021-11-05 14:03 ` [bug#51543] [PATCH 2/2] doc: Improve documentation of the Bash home service Xinglu Chen
2021-11-05 19:36 ` Liliana Marie Prikler
2021-11-07 11:20 ` Xinglu Chen
2021-11-07 11:36 ` [bug#51543] [PATCH v3 0/2] Some improvements to " Xinglu Chen
2021-11-07 11:36 ` [bug#51543] [PATCH v3 1/2] home: services: bash: Add ‘aliases’ field Xinglu Chen
2021-11-07 11:36 ` [bug#51543] [PATCH v3 2/2] doc: Improve documentation of the Bash home service Xinglu Chen
2021-11-07 20:18 ` Liliana Marie Prikler
2021-11-07 20:58 ` bug#51543: [PATCH 0/2] Some improvements to " Ludovic Courtès
2021-11-13 20:35 ` [bug#51543] " Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a92171a4ae30035432b14550243743c9b675e0a5.1635759705.git.public@yoctocell.xyz \
--to=public@yoctocell.xyz \
--cc=51543@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.