Bug 1308274

Summary: Editorial problem with builtins(1) manpage (Doc Only)
Product: Red Hat Enterprise Linux 7 Reporter: Noel McLoughlin <noel.mcloughlin>
Component: bashAssignee: Siteshwar Vashisht <svashisht>
Status: CLOSED WONTFIX QA Contact: BaseOS QE - Apps <qe-baseos-apps>
Severity: low Docs Contact:
Priority: unspecified    
Version: 7.4CC: admiller, extras-qa, jkejda, mmaslano, nforro
Target Milestone: rcKeywords: ManPageChange
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: 1308273 Environment:
CentOS Linux release 7.2.1511 (Core) bash-4.2.46-19.el7.x86_64, /usr/share/man/man1/builtins.1.gz
Last Closed: 2018-10-31 14:14:54 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Noel McLoughlin 2016-02-13 23:34:44 UTC
+++ This bug was initially created as a clone of Bug #1308273 +++

Description of problem:

The builtins(1) man page consistently references sections which cannot be found in same builtins(1). This is confusing since builtins are key features of bash, one of the primary interface to Linux OS for power users.

REPLICATING ISSUE

1. Open builtins man page

$ man builtins

2. Find instances of following text.

(see Arrays above)
(see ARITHMETIC EVALUATION above)
(see READLINE above)
(see  SHELL GRAMMAR above) *2
(see COMMAND EXECUTION ENVIRONMENT above)
(see JOB CONTROL above) *
(see  Shell  Variables above)
(see Brace Expansion above)
(see Pattern Matching above)
(see Completing under READLINE above)
(see COMMENTS above)
(see INVOCATION above)
(see Pathname Expansion above)
(see Programmable Completion above) 

3. Note referenced section do not exist in builtins(1).



WORKAROUND

1. Open bash man page.
$ man bash

2. Note referenced section exist in bash(1).

Arrays
ARITHMETIC EVALUATION
READLINE
SHELL GRAMMAR
COMMAND EXECUTION ENVIRONMENT
JOB CONTROL
Shell  Variables
Brace Expansion
Pattern Matching
Completing under READLINE
COMMENTS
INVOCATION
Pathname Expansion
Programmable Completion

Comment 3 Siteshwar Vashisht 2017-01-18 15:10:35 UTC
The patch in comment 2 is not in upstream yet.

Comment 4 Siteshwar Vashisht 2018-10-31 14:14:54 UTC
I will look into fixing this in fedora/upstream, but it's not on priority for rhel 7. So closing as wontfix.