From ff20d3928dcd6c00be1e8e6c87fd6bcd11d48fd0 Mon Sep 17 00:00:00 2001 From: Oleg Pykhalov Date: Sat, 16 Oct 2021 16:44:55 +0300 Subject: home: services: shells: Fix documentation about file-like objects. * gnu/home/services/shells.scm: (home-shell-profile-configuration, home-shell-profile-service-type, home-zsh-configuration, home-zsh-extension, home-bash-configuration, home-bash-extension, home-fish-configuration, home-fish-extension): Replace 'strings or gexps' with 'file-like objects' in the documentation. * doc/guix.texi (Shells Home Services): Same. --- doc/guix.texi | 18 +++++++++--------- gnu/home/services/shells.scm | 40 ++++++++++++++++++++-------------------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 7a4b2c040b..a49abc0554 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -35700,7 +35700,7 @@ Available @code{home-shell-profile-configuration} fields are: @item @code{profile} (default: @code{()}) (type: text-config) @code{home-shell-profile} is instantiated automatically by @code{home-environment}, DO NOT create this service manually, it can -only be extended. @code{profile} is a list of strings or gexps, which +only be extended. @code{profile} is a list of file-like objects, which will go to @file{~/.profile}. By default @file{~/.profile} contains the initialization code, which have to be evaluated by login shell to make home-environment's profile avaliable to the user, but other commands can @@ -35729,19 +35729,19 @@ Add sane defaults like reading @file{/etc/bashrc}, coloring output for Association list of environment variables to set for the Bash session. @item @code{bash-profile} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.bash_profile}. +List of file-like objects, which will be added to @file{.bash_profile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). @file{.bash_login} won't be ever read, because @file{.bash_profile} always present. @item @code{bashrc} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.bashrc}. Used +List of file-like objects, which will be added to @file{.bashrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{bash} or by terminal app or any other program). @item @code{bash-logout} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.bash_logout}. +List of file-like objects, which will be added to @file{.bash_logout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example). @@ -35769,30 +35769,30 @@ Shell startup process will continue with Association list of environment variables to set for the Zsh session. @item @code{zshenv} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.zshenv}. Used +List of file-like objects, which will be added to @file{.zshenv}. Used for setting user's shell environment variables. Must not contain commands assuming the presence of tty or producing output. Will be read always. Will be read before any other file in @env{ZDOTDIR}. @item @code{zprofile} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.zprofile}. Used +List of file-like objects, which will be added to @file{.zprofile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). Will be read before @file{.zlogin}. @item @code{zshrc} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.zshrc}. Used +List of file-like objects, which will be added to @file{.zshrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{zsh} or by terminal app or any other program). @item @code{zlogin} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.zlogin}. Used +List of file-like objects, which will be added to @file{.zlogin}. Used for executing user's commands at the end of starting process of login shell. @item @code{zlogout} (default: @code{()}) (type: text-config) -List of strings or gexps, which will be added to @file{.zlogout}. Used +List of file-like objects, which will be added to @file{.zlogout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example). diff --git a/gnu/home/services/shells.scm b/gnu/home/services/shells.scm index 1cd17b2c32..e2730967b2 100644 --- a/gnu/home/services/shells.scm +++ b/gnu/home/services/shells.scm @@ -66,7 +66,7 @@ @code{home-environment}, DO NOT create this service manually, it can only be extended. -@code{profile} is a list of strings or gexps, which will go to +@code{profile} is a list of file-like objects, which will go to @file{~/.profile}. By default @file{~/.profile} contains the initialization code, which have to be evaluated by login shell to make home-environment's profile avaliable to the user, but other commands @@ -107,7 +107,7 @@ $HOME_ENVIRONMENT/on-first-login\n" (default-value (home-shell-profile-configuration)) (description "Create @file{~/.profile}, which is used for environment initialization of POSIX compliant login shells. This -service type can be extended with a list of strings or gexps."))) +service type can be extended with a list of file-like objects."))) (define (serialize-boolean field-name val) "") (define (serialize-posix-env-vars field-name val) @@ -143,30 +143,30 @@ Shell startup process will continue with serialize-posix-env-vars) (zshenv (text-config '()) - "List of strings or gexps, which will be added to @file{.zshenv}. + "List of file-like objects, which will be added to @file{.zshenv}. Used for setting user's shell environment variables. Must not contain commands assuming the presence of tty or producing output. Will be read always. Will be read before any other file in @env{ZDOTDIR}.") (zprofile (text-config '()) - "List of strings or gexps, which will be added to @file{.zprofile}. + "List of file-like objects, which will be added to @file{.zprofile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). Will be read before @file{.zlogin}.") (zshrc (text-config '()) - "List of strings or gexps, which will be added to @file{.zshrc}. + "List of file-like objects, which will be added to @file{.zshrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{zsh} or by terminal app or any other program).") (zlogin (text-config '()) - "List of strings or gexps, which will be added to @file{.zlogin}. + "List of file-like objects, which will be added to @file{.zlogin}. Used for executing user's commands at the end of starting process of login shell.") (zlogout (text-config '()) - "List of strings or gexps, which will be added to @file{.zlogout}. + "List of file-like objects, which will be added to @file{.zlogout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example).")) @@ -244,19 +244,19 @@ source ~/.profile "Association list of environment variables to set.") (zshrc (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (zshenv (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (zprofile (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (zlogin (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (zlogout (text-config '()) - "List of strings or gexps.")) + "List of file-like objects.")) (define (home-zsh-extensions original-config extension-configs) (home-zsh-configuration @@ -319,19 +319,19 @@ for @code{ls} provided by guix to @file{.bashrc}.") serialize-posix-env-vars) (bash-profile (text-config '()) - "List of strings or gexps, which will be added to @file{.bash_profile}. + "List of file-like objects, which will be added to @file{.bash_profile}. Used for executing user's commands at start of login shell (In most cases the shell started on tty just after login). @file{.bash_login} won't be ever read, because @file{.bash_profile} always present.") (bashrc (text-config '()) - "List of strings or gexps, which will be added to @file{.bashrc}. + "List of file-like objects, which will be added to @file{.bashrc}. Used for executing user's commands at start of interactive shell (The shell for interactive usage started by typing @code{bash} or by terminal app or any other program).") (bash-logout (text-config '()) - "List of strings or gexps, which will be added to @file{.bash_logout}. + "List of file-like objects, which will be added to @file{.bash_logout}. Used for executing user's commands at the exit of login shell. It won't be read in some cases (if the shell terminates by exec'ing another process for example).")) @@ -426,13 +426,13 @@ if [ -f ~/.bashrc ]; then source ~/.bashrc; fi "Association list of environment variables to set.") (bash-profile (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (bashrc (text-config '()) - "List of strings or gexps.") + "List of file-like objects.") (bash-logout (text-config '()) - "List of strings or gexps.")) + "List of file-like objects.")) (define (home-bash-extensions original-config extension-configs) (home-bash-configuration @@ -506,7 +506,7 @@ if [ -f ~/.bashrc ]; then source ~/.bashrc; fi "The Fish package to use.") (config (text-config '()) - "List of strings or gexps, which will be added to + "List of file-like objects, which will be added to @file{$XDG_CONFIG_HOME/fish/config.fish}.") (environment-variables (alist '()) @@ -553,7 +553,7 @@ end\n\n") (define-configuration/no-serialization home-fish-extension (config (text-config '()) - "List of strings or gexps for extending the Fish initialization file.") + "List of file-like objects for extending the Fish initialization file.") (environment-variables (alist '()) "Association list of environment variables to set.") -- cgit v1.2.3