Bash 5.2: Missing ‘shopt’ option ‘syslog_history’ in doc/bashref.texi

[tpeplt]

Bash Maintainers,

   The texinfo version of the bash manual is missing a description of
the ‘shopt’ option ‘syslog_history’.  This can be confirmed by
downloading bash-master.tar.gz from:

http://git.savannah.gnu.org/cgit/bash.git/snapshot/bash-master.tar.gz

Searching the file bash-master/doc/bashref.texi gives no instance of
"syslog" or "syslog_history".  An entry for ‘syslog_history’ is provided
in the ‘man’ page for ‘bash’:

   syslog_history
  If set, command history is logged to syslog.

To match the ‘man’ page for ‘bash’, an entry should be added to
‘bashref.texi’ between the following two entries (which start at line
5900 in the file):

> @item varredir_close
> If set, the shell automatically closes file descriptors assigned using the
> @code{@{varname@}} redirection syntax (@pxref{Redirections}) instead of
> leaving them open when the command completes.
> 
> @item xpg_echo
> If set, the @code{echo} builtin expands backslash-escape sequences
> by default.

This would then match the non-alphabetical ordering of the ‘shopts’
options in the ‘man’ page.

A better solution would be to fix the non-alphabetical ordering in the
‘man’ page (move ‘syslog_history’ entry before the ‘varredir_close’
entry) and add a matching entry to ‘bashref.texi’ in the alphabetically
correct ordering.

--

Re: Bash 5.2: Missing ‘shopt’ option ‘syslog_history’ in doc/bashref.texi

[tpeplt]

Chet Ramey  writes:

> On 3/17/24 12:50 PM, tpeplt wrote:
>> Searching the file bash-master/doc/bashref.texi gives no instance of
>> "syslog" or "syslog_history".  An entry for ‘syslog_history’ is provided
>> in the ‘man’ page for ‘bash’:
>> syslog_history
>>If set, command history is logged to syslog.
>
> Not in the version of bash you downloaded. This must be a vendor addition.

Thank you.

Prior to write a bug report, I searched this mailing list’s archives for
syslog and syslog_history and found several requests for a feature.  I
then assumed that it had been added (including in the ‘man’ page), but
had been missed in the .texi source.

--