Bug 1467390

Summary: GNU coding standards info documentation missing
Product: Red Hat Enterprise Linux 7 Reporter: Don Pellegrino <don>
Component: binutilsAssignee: Nick Clifton <nickc>
Status: CLOSED ERRATA QA Contact: Miloš Prchlík <mprchlik>
Severity: low Docs Contact: Vladimír Slávik <vslavik>
Priority: unspecified    
Version: 7.5CC: don, fweimer, law, mcermak, mnewsome, mprchlik, ohudlick, vslavik
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Cause: The standards.info documentation file has gone missing from recent distributions. Consequence: The info system is now missing a node that describes the GNU Coding Standard. This can lead to confusion and frustration with the users of the info system. Fix: Add the standards.info file to the binutils package so that it will be installed when the binutils are installed. Result: The info system is no longer missing a node.
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-04-10 09:59:05 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:
Bug Depends On:    
Bug Blocks: 1473718    
Attachments:
Description Flags
Proposed patch
none
Compressed standards.info file none

Description Don Pellegrino 2017-07-03 15:41:12 UTC
Description of problem:

The info documentation index includes an entry under section "GNU organization" for "Standards" with description "GNU coding standards." However, when this entry is selected the error "Info file standards does not exist" is reported.

How reproducible:

Always

Steps to Reproduce:
1. Open emacs
2. M-x info
3. Observe info index entry for "Standards" and error on selection

Actual results:

Documentation is missing

Expected results:

Documentation should be shown on selection

Additional info:

yum provides "*standards.info" does not return any hits. This file should be in the distribution somewhere. Upstream for the file can be found at https://www.gnu.org/prep/standards/

Comment 2 Don Pellegrino 2017-07-03 15:47:34 UTC
It looks like the file was in previous versions of binutils:

yum provides "*standards.info*"
Loaded plugins: langpacks, product-id, search-disabled-repos, subscription-
              : manager
binutils-2.23.52.0.1-16.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-eus-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-16.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-eus-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7_1.1.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-eus-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7_1.1.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7_1.2.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-eus-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-30.el7_1.2.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-55.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-eus-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



binutils-2.23.52.0.1-55.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-7-server-rpms
Matched from:
Filename    : /usr/share/info/standards.info.gz



devtoolset-3-binutils-2.24-18.el7.x86_64 : A GNU collection of binary utilities
Repo        : rhel-server-rhscl-7-rpms
Matched from:
Filename    : /opt/rh/devtoolset-3/root/usr/share/info/standards.info.gz



xemacs-packages-extra-info-20140715-1.el7.noarch : XEmacs packages documentation
                                                 : in GNU texinfo format
Repo        : epel
Matched from:
Filename    : /usr/share/xemacs/mule-packages/info/latin-euro-standards.info.gz

However, it is missing from 2.25.1:

$ sudo yum info binutils
Loaded plugins: langpacks, product-id, search-disabled-repos, subscription-
              : manager
Installed Packages
Name        : binutils
Arch        : x86_64
Version     : 2.25.1
Release     : 22.base.el7
Size        : 22 M
Repo        : installed
From repo   : rhel-7-server-rpms
Summary     : A GNU collection of binary utilities
URL         : http://sources.redhat.com/binutils
License     : GPLv3+
Description : Binutils is a collection of binary utilities, including ar (for
            : creating, modifying and extracting from archives), as (a family of
            : GNU assemblers), gprof (for displaying call graph profile data),
            : ld (the GNU linker), nm (for listing symbols from object files),
            : objcopy (for copying and translating object files), objdump (for
            : displaying information from object files), ranlib (for generating
            : an index for the contents of an archive), readelf (for displaying
            : detailed information about binary files), size (for listing the
            : section sizes of an object or archive file), strings (for listing
            : printable strings from files), strip (for discarding symbols), and
            : addr2line (for converting addresses to file and line).

$ rpm -ql binutils
/usr/bin/addr2line
/usr/bin/ar
/usr/bin/as
/usr/bin/c++filt
/usr/bin/dwp
/usr/bin/elfedit
/usr/bin/gprof
/usr/bin/ld
/usr/bin/ld.bfd
/usr/bin/ld.gold
/usr/bin/nm
/usr/bin/objcopy
/usr/bin/objdump
/usr/bin/ranlib
/usr/bin/readelf
/usr/bin/size
/usr/bin/strings
/usr/bin/strip
/usr/lib64/libbfd-2.25.1-22.base.el7.so
/usr/lib64/libopcodes-2.25.1-22.base.el7.so
/usr/share/doc/binutils-2.25.1
/usr/share/doc/binutils-2.25.1/README
/usr/share/info/as.info.gz
/usr/share/info/binutils.info.gz
/usr/share/info/gprof.info.gz
/usr/share/info/ld.info.gz
/usr/share/locale/bg/LC_MESSAGES/binutils.mo
/usr/share/locale/bg/LC_MESSAGES/gprof.mo
/usr/share/locale/bg/LC_MESSAGES/ld.mo
/usr/share/locale/da/LC_MESSAGES/bfd.mo
/usr/share/locale/da/LC_MESSAGES/binutils.mo
/usr/share/locale/da/LC_MESSAGES/gprof.mo
/usr/share/locale/da/LC_MESSAGES/ld.mo
/usr/share/locale/da/LC_MESSAGES/opcodes.mo
/usr/share/locale/de/LC_MESSAGES/gprof.mo
/usr/share/locale/de/LC_MESSAGES/opcodes.mo
/usr/share/locale/eo/LC_MESSAGES/gprof.mo
/usr/share/locale/es/LC_MESSAGES/bfd.mo
/usr/share/locale/es/LC_MESSAGES/binutils.mo
/usr/share/locale/es/LC_MESSAGES/gas.mo
/usr/share/locale/es/LC_MESSAGES/gold.mo
/usr/share/locale/es/LC_MESSAGES/gprof.mo
/usr/share/locale/es/LC_MESSAGES/ld.mo
/usr/share/locale/es/LC_MESSAGES/opcodes.mo
/usr/share/locale/fi/LC_MESSAGES/bfd.mo
/usr/share/locale/fi/LC_MESSAGES/binutils.mo
/usr/share/locale/fi/LC_MESSAGES/gas.mo
/usr/share/locale/fi/LC_MESSAGES/gold.mo
/usr/share/locale/fi/LC_MESSAGES/gprof.mo
/usr/share/locale/fi/LC_MESSAGES/ld.mo
/usr/share/locale/fi/LC_MESSAGES/opcodes.mo
/usr/share/locale/fr/LC_MESSAGES/bfd.mo
/usr/share/locale/fr/LC_MESSAGES/binutils.mo
/usr/share/locale/fr/LC_MESSAGES/gas.mo
/usr/share/locale/fr/LC_MESSAGES/gprof.mo
/usr/share/locale/fr/LC_MESSAGES/ld.mo
/usr/share/locale/fr/LC_MESSAGES/opcodes.mo
/usr/share/locale/ga/LC_MESSAGES/gprof.mo
/usr/share/locale/ga/LC_MESSAGES/ld.mo
/usr/share/locale/ga/LC_MESSAGES/opcodes.mo
/usr/share/locale/hr/LC_MESSAGES/binutils.mo
/usr/share/locale/hu/LC_MESSAGES/gprof.mo
/usr/share/locale/id/LC_MESSAGES/bfd.mo
/usr/share/locale/id/LC_MESSAGES/binutils.mo
/usr/share/locale/id/LC_MESSAGES/gas.mo
/usr/share/locale/id/LC_MESSAGES/gold.mo
/usr/share/locale/id/LC_MESSAGES/gprof.mo
/usr/share/locale/id/LC_MESSAGES/ld.mo
/usr/share/locale/id/LC_MESSAGES/opcodes.mo
/usr/share/locale/it/LC_MESSAGES/binutils.mo
/usr/share/locale/it/LC_MESSAGES/gold.mo
/usr/share/locale/it/LC_MESSAGES/gprof.mo
/usr/share/locale/it/LC_MESSAGES/ld.mo
/usr/share/locale/it/LC_MESSAGES/opcodes.mo
/usr/share/locale/ja/LC_MESSAGES/bfd.mo
/usr/share/locale/ja/LC_MESSAGES/binutils.mo
/usr/share/locale/ja/LC_MESSAGES/gas.mo
/usr/share/locale/ja/LC_MESSAGES/gprof.mo
/usr/share/locale/ja/LC_MESSAGES/ld.mo
/usr/share/locale/ms/LC_MESSAGES/gprof.mo
/usr/share/locale/nl/LC_MESSAGES/gprof.mo
/usr/share/locale/nl/LC_MESSAGES/opcodes.mo
/usr/share/locale/pt_BR/LC_MESSAGES/gprof.mo
/usr/share/locale/pt_BR/LC_MESSAGES/opcodes.mo
/usr/share/locale/ro/LC_MESSAGES/bfd.mo
/usr/share/locale/ro/LC_MESSAGES/binutils.mo
/usr/share/locale/ro/LC_MESSAGES/gprof.mo
/usr/share/locale/ro/LC_MESSAGES/opcodes.mo
/usr/share/locale/ru/LC_MESSAGES/bfd.mo
/usr/share/locale/ru/LC_MESSAGES/binutils.mo
/usr/share/locale/ru/LC_MESSAGES/gas.mo
/usr/share/locale/ru/LC_MESSAGES/gprof.mo
/usr/share/locale/rw/LC_MESSAGES/bfd.mo
/usr/share/locale/rw/LC_MESSAGES/binutils.mo
/usr/share/locale/rw/LC_MESSAGES/gas.mo
/usr/share/locale/rw/LC_MESSAGES/gprof.mo
/usr/share/locale/sk/LC_MESSAGES/binutils.mo
/usr/share/locale/sr/LC_MESSAGES/binutils.mo
/usr/share/locale/sr/LC_MESSAGES/gprof.mo
/usr/share/locale/sv/LC_MESSAGES/bfd.mo
/usr/share/locale/sv/LC_MESSAGES/binutils.mo
/usr/share/locale/sv/LC_MESSAGES/gprof.mo
/usr/share/locale/sv/LC_MESSAGES/ld.mo
/usr/share/locale/sv/LC_MESSAGES/opcodes.mo
/usr/share/locale/tr/LC_MESSAGES/bfd.mo
/usr/share/locale/tr/LC_MESSAGES/binutils.mo
/usr/share/locale/tr/LC_MESSAGES/gas.mo
/usr/share/locale/tr/LC_MESSAGES/gprof.mo
/usr/share/locale/tr/LC_MESSAGES/ld.mo
/usr/share/locale/tr/LC_MESSAGES/opcodes.mo
/usr/share/locale/uk/LC_MESSAGES/bfd.mo
/usr/share/locale/uk/LC_MESSAGES/binutils.mo
/usr/share/locale/uk/LC_MESSAGES/gas.mo
/usr/share/locale/uk/LC_MESSAGES/gprof.mo
/usr/share/locale/uk/LC_MESSAGES/ld.mo
/usr/share/locale/uk/LC_MESSAGES/opcodes.mo
/usr/share/locale/vi/LC_MESSAGES/bfd.mo
/usr/share/locale/vi/LC_MESSAGES/binutils.mo
/usr/share/locale/vi/LC_MESSAGES/gold.mo
/usr/share/locale/vi/LC_MESSAGES/gprof.mo
/usr/share/locale/vi/LC_MESSAGES/ld.mo
/usr/share/locale/vi/LC_MESSAGES/opcodes.mo
/usr/share/locale/zh_CN/LC_MESSAGES/bfd.mo
/usr/share/locale/zh_CN/LC_MESSAGES/binutils.mo
/usr/share/locale/zh_CN/LC_MESSAGES/ld.mo
/usr/share/locale/zh_CN/LC_MESSAGES/opcodes.mo
/usr/share/locale/zh_TW/LC_MESSAGES/binutils.mo
/usr/share/locale/zh_TW/LC_MESSAGES/ld.mo
/usr/share/man/man1/addr2line.1.gz
/usr/share/man/man1/ar.1.gz
/usr/share/man/man1/as.1.gz
/usr/share/man/man1/c++filt.1.gz
/usr/share/man/man1/elfedit.1.gz
/usr/share/man/man1/gprof.1.gz
/usr/share/man/man1/ld.1.gz
/usr/share/man/man1/nm.1.gz
/usr/share/man/man1/objcopy.1.gz
/usr/share/man/man1/objdump.1.gz
/usr/share/man/man1/ranlib.1.gz
/usr/share/man/man1/readelf.1.gz
/usr/share/man/man1/size.1.gz
/usr/share/man/man1/strings.1.gz
/usr/share/man/man1/strip.1.gz

Comment 4 Nick Clifton 2017-08-10 16:01:08 UTC
The GNU Coding Standards documentation is not part of the binutils package.  It may have been in the past, but that was a mistake.  The information is part of the FSF gnulib project (https://www.gnu.org/software/gnulib/) so I am changing the component to match that.

Comment 6 Nick Clifton 2017-08-15 07:22:22 UTC
Created attachment 1313494 [details]
Proposed patch

There is currently no suitable RHEL package to provide the standards.info file,
so this patch adds it back into the binutils rpm.

Comment 7 Nick Clifton 2017-08-15 07:23:08 UTC
Created attachment 1313495 [details]
Compressed standards.info file

Comment 8 Nick Clifton 2017-08-15 07:24:27 UTC
I have created a patch to add the required functionality.  Should this BZ prove to acceptable for the RHEL 7.5 release it can go in when ready.

Comment 9 Nick Clifton 2017-08-30 08:11:41 UTC
The patch has been added to the 7.5 binutils.

Comment 11 Miloš Prchlík 2018-01-31 11:11:03 UTC
Verified with build binutils-2.27-27.base.el7.

Comment 14 errata-xmlrpc 2018-04-10 09:59:05 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2018:0686