bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Avoid pronouns in documentation


From: Andrew Church
Subject: [PATCH] Avoid pronouns in documentation
Date: Mon, 07 Jun 2021 22:19:52 +0900

In the context of the recent discussion regarding the use of pronouns in
the Bash documentation, here is an alternate patch which rewrites the
relevant sentences to avoid altogether the use of pronouns to refer to
an unspecified person.

(Someone may have once said, "If all your answers are bad ones, you're
asking the wrong question.")

I've left pronouns referring to specific individuals unchanged, on the
assumption that those pronouns are correct for those individuals.

  --Andrew Church
    http://achurch.org/

diff --git a/doc/bashref.texi b/doc/bashref.texi
index 620e13de..82e15900 100644
--- a/doc/bashref.texi
+++ b/doc/bashref.texi
@@ -7844,11 +7844,11 @@ the shell spawned to execute the script.
 The restricted shell mode is only one component of a useful restricted
 environment. It should be accompanied by setting @env{PATH} to a value
 that allows execution of only a few verified commands (commands that
-allow shell escapes are particularly vulnerable), leaving the user
-in a non-writable directory other than his home directory after login,
-not allowing the restricted shell to execute shell scripts, and cleaning
-the environment of variables that cause some commands to modify their
-behavior (e.g., @env{VISUAL} or @env{PAGER}).
+allow shell escapes are particularly vulnerable), changing the current
+directory to a non-writable directory other than the user's home
+directory after login, not allowing the restricted shell to execute
+shell scripts, and cleaning the environment of variables that cause some
+commands to modify their behavior (e.g., @env{VISUAL} or @env{PAGER}).
 
 Modern systems provide more secure ways to implement a restricted environment,
 such as @code{jails}, @code{zones}, or @code{containers}.
diff --git a/doc/oldbash.texi b/doc/oldbash.texi
index b8e9a866..1e3f006e 100644
--- a/doc/oldbash.texi
+++ b/doc/oldbash.texi
@@ -8805,7 +8805,7 @@ fi
 
 LOGIN_SHELL=true
 
-# If the user has her own init file, then use that one, else use
+# If the user has a custom init file, then use that one, else use
 # the canonical one.
 @c why in separate rc file instead of right here?
 if [ -f ~/.bashrc ]; then
diff --git a/lib/readline/doc/rltech.texi b/lib/readline/doc/rltech.texi
index d234dd8b..caf90f55 100644
--- a/lib/readline/doc/rltech.texi
+++ b/lib/readline/doc/rltech.texi
@@ -1651,8 +1651,8 @@ main (int c, char **v)
 
 Signals are asynchronous events sent to a process by the Unix kernel,
 sometimes on behalf of another process.  They are intended to indicate
-exceptional events, like a user pressing the interrupt key on his terminal,
-or a network connection being broken.  There is a class of signals that can
+exceptional events, like a user pressing the terminal's interrupt key, or
+a network connection being broken.  There is a class of signals that can
 be sent to the process currently reading input from the keyboard.  Since
 Readline changes the terminal attributes when it is called, it needs to
 perform special processing when such a signal is received in order to
@@ -2199,9 +2199,9 @@ shell variables and hostnames.
 
 @deftypevar int rl_completion_query_items
 Up to this many items will be displayed in response to a
-possible-completions call.  After that, readline asks the user if she is sure
-she wants to see them all.  The default value is 100.  A negative value 
-indicates that Readline should never ask the user.
+possible-completions call.  After that, Readline asks the user for
+confirmation of whether to display them all.  The default value is 100.
+A negative value indicates that Readline should never ask the user.
 @end deftypevar
 
 @deftypevar {int} rl_completion_append_character
diff --git a/lib/readline/doc/rluser.texi b/lib/readline/doc/rluser.texi
index f4d4860d..19bb395e 100644
--- a/lib/readline/doc/rluser.texi
+++ b/lib/readline/doc/rluser.texi
@@ -338,8 +338,8 @@ typed by the user or be part of the contents of the current 
line.
 Although the Readline library comes with a set of Emacs-like
 keybindings installed by default, it is possible to use a different set
 of keybindings.
-Any user can customize programs that use Readline by putting
-commands in an @dfn{inputrc} file, conventionally in his home directory.
+Any user can customize programs that use Readline by putting commands
+in an @dfn{inputrc} file, conventionally in the user's home directory.
 The name of this
 @ifset BashFeatures
 file is taken from the value of the shell variable @env{INPUTRC}.  If



reply via email to

[Prev in Thread] Current Thread [Next in Thread]