RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 609995 - Typos and enhancements in text
Summary: Typos and enhancements in text
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: doc-Developer_Guide
Version: 6.0
Hardware: All
OS: Linux
medium
medium
Target Milestone: rc
: ---
Assignee: Don Domingo
QA Contact: Michal Nowak
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-07-01 11:48 UTC by Michal Nowak
Modified: 2013-03-08 02:10 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-11-11 15:29:07 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Michal Nowak 2010-07-01 11:48:10 UTC
Typos in DevGuide6
==================

I just have read http://brisvegas.bne.redhat.com/rhel6-devguide/index-single.html and found there few typos and parts which you might want to enhance:

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"compat-libstdc++-296 (Red Hat Enterprise 2.1)"
->
"compat-libstdc++-296 (Red Hat Enterprise Linux 2.1)"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Re: "Ancient SUSE". What's the source of this sentence? Description in spec file says:
"""
This package includes a GCC 3.2.3-RH compatibility compiler.
"""
See: https://brewweb.devel.redhat.com/buildinfo?buildID=136030

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here we have "static" URI file:///usr/share/doc/boost-doc-1.41.0/index.html however we usually use URIs this way: file:///usr/share/doc/boost-doc-version/index.html.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(missing 'be')
"Hover help for all installed libhover libraries is enabled by default, and it can disabled per project."
->
"Hover help for all installed libhover libraries is enabled by default, and it can be disabled per project."

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

We don't have python-2.6.4, just 2.6.2, however just "version" seems to me more appropriate:
file:///usr/share/doc/python-docs-2.6.4/html/index.html
->
file:///usr/share/doc/python-docs-version/html/index.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"""
3.8.2. Java
The java-1.6.0-openjdk package adds support for the Java programming language. This package provides the java interpreter. The java-1.6.0-openjdk-devel package contains the libraries and header files needed for developing Java extensions.
"""

...and notably, java-1.6.0-openjdk-devel contains the `javac` compiler.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Re: 4.1.  Compiling with GNU GCC: remove spaces:
"Section 4.1.2, “ Using GCC Tools ”" -> "Section 4.1.2, “Using GCC Tools”"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"""
Since the release of Red Hat Enterprise Linux 6, GCC has had three major releases: 4.2.x, 4.3.x, and 4.4.x.
"""
->
"""
Since the release of Red Hat Enterprise Linux 5, GCC has had three major releases: 4.2.x, 4.3.x, and 4.4.x.
"""

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

elfutils has nothing to do with compiling, as opposite to binutils, however tools from elfutils package are usefull when inspecting object resulted from compilation, such as object files and binaries:
"""
In addition, you can also install elfutils  to add ELF-specific compiling features.
"""

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In: "4.1.3.  GCC Documentation" links should be updated to point to 4.4.4 release.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In: "4.3.3. Autotools Documentation" link http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Autotools_Plug-In_for_Eclipse/index.html is dead.

as well as http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/GDB_and_Python_Pretty_Printers/ in "5.4. Python Pretty-Printers"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In TOC there's Karsten's name in link text: "4.3. Autotools (Karsten Hopp)"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Just to note we provide -debuginfo packages for all arch-dependant, that means non-noarch, packages.
"""
Red Hat Enterprise Linux also provides -debuginfo  packages for nearly all RPMs included in the operating system.
"""

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Not sure if "programme" is correct US English.
"programme" -> "program"

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In "5.2.2. Running GDB", it's not common to write program with indentation of four spaces, common is to start w/o spaces

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In this guide is mostly used file:///PATH/... not just /PATH/...
/usr/share/doc/valgrind-version/valgrind_manual.pdf  and /usr/share/doc/valgrind-version/html/index.html
+ /usr/share/doc/oprofile-version/
+ /usr/share/doc/oprofile-version/oprofile.html
+ /usr/share/doc/oprofile-version/internals.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"""
kernel-version-devel, kernel-version-debuginfo, and kernel-version-debuginfo-common.
"""
kernel-2.6.32-33.el6.x86_64
kernel-debuginfo-common-x86_64-2.6.32-37.el6.x86_64
kernel-headers-2.6.32-37.el6.x86_64
kernel-devel-2.6.32-33.el6.x86_64

So it's: e.g. kernel-devel-version

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Comment 1 RHEL Program Management 2010-07-01 12:03:19 UTC
This request was evaluated by Red Hat Product Management for inclusion in a Red
Hat Enterprise Linux major release.  Product Management has requested further
review of this request by Red Hat Engineering, for potential inclusion in a Red
Hat Enterprise Linux Major release.  This request is not yet committed for
inclusion.

Comment 2 Don Domingo 2010-07-08 02:41:43 UTC
(In reply to comment #0)
> Typos in DevGuide6
> ==================
> 
> I just have read
> http://brisvegas.bne.redhat.com/rhel6-devguide/index-single.html and found
> there few typos and parts which you might want to enhance:
> 
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> "compat-libstdc++-296 (Red Hat Enterprise 2.1)"
> ->
> "compat-libstdc++-296 (Red Hat Enterprise Linux 2.1)"
> 

corrected
http://brisvegas.bne.redhat.com/rhel6-devguide/libraries.libstdcxx.html
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Re: "Ancient SUSE". What's the source of this sentence? Description in spec
> file says:
> """
> This package includes a GCC 3.2.3-RH compatibility compiler.
> """
> See: https://brewweb.devel.redhat.com/buildinfo?buildID=136030
> 

removed "Ancient SUSE"
http://brisvegas.bne.redhat.com/rhel6-devguide/libraries.libstdcxx.html
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Here we have "static" URI file:///usr/share/doc/boost-doc-1.41.0/index.html
> however we usually use URIs this way:
> file:///usr/share/doc/boost-doc-version/index.html.
> 
> 

corrected
http://brisvegas.bne.redhat.com/rhel6-devguide/boost.docs.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> (missing 'be')
> "Hover help for all installed libhover libraries is enabled by default, and it
> can disabled per project."
> ->
> "Hover help for all installed libhover libraries is enabled by default, and it
> can be disabled per project."
> 
> 

corrected
http://brisvegas.bne.redhat.com/rhel6-devguide/libhover.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> We don't have python-2.6.4, just 2.6.2, however just "version" seems to me more
> appropriate:
> file:///usr/share/doc/python-docs-2.6.4/html/index.html
> ->
> file:///usr/share/doc/python-docs-version/html/index.html
> 
> 

corrected
http://brisvegas.bne.redhat.com/rhel6-devguide/ch-lib-othersupport.html#libraries.python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> """
> 3.8.2. Java
> The java-1.6.0-openjdk package adds support for the Java programming language.
> This package provides the java interpreter. The java-1.6.0-openjdk-devel
> package contains the libraries and header files needed for developing Java
> extensions.
> """
> 
> ...and notably, java-1.6.0-openjdk-devel contains the `javac` compiler.
> 
> 

revised:

<quote>
The java-1.6.0-openjdk-devel package contains the javac compiler, as well as the libraries and header files needed for developing java extensions
</quote>
http://brisvegas.bne.redhat.com/rhel6-devguide/libraries.java.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Re: 4.1.  Compiling with GNU GCC: remove spaces:
> "Section 4.1.2, “ Using GCC Tools ”" -> "Section 4.1.2, “Using GCC Tools”"
> 
> 

done
http://brisvegas.bne.redhat.com/rhel6-devguide/compilers.html#using.gcc.tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> """
> Since the release of Red Hat Enterprise Linux 6, GCC has had three major
> releases: 4.2.x, 4.3.x, and 4.4.x.
> """
> ->
> """
> Since the release of Red Hat Enterprise Linux 5, GCC has had three major
> releases: 4.2.x, 4.3.x, and 4.4.x.
> """
> 

corrected
http://brisvegas.bne.redhat.com/rhel6-devguide/compilers.html#gcc.features
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> elfutils has nothing to do with compiling, as opposite to binutils, however
> tools from elfutils package are usefull when inspecting object resulted from
> compilation, such as object files and binaries:
> """
> In addition, you can also install elfutils  to add ELF-specific compiling
> features.
> """
> 

removed sentence altogether
http://brisvegas.bne.redhat.com/rhel6-devguide/compilers.html#using.gcc.tools
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> In: "4.1.3.  GCC Documentation" links should be updated to point to 4.4.4
> release.
> 

done
http://brisvegas.bne.redhat.com/rhel6-devguide/compilers.html#gcc.docs
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> In: "4.3.3. Autotools Documentation" link
> http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Autotools_Plug-In_for_Eclipse/index.html
> is dead.
> 

this book will be up on GA.

> as well as
> http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/GDB_and_Python_Pretty_Printers/
> in "5.4. Python Pretty-Printers"
> 
> 

same here

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> In TOC there's Karsten's name in link text: "4.3. Autotools (Karsten Hopp)"
> 
> 
weird; must be a build artifact. removed name altogether (used to be tagged as comment)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Just to note we provide -debuginfo packages for all arch-dependant, that means
> non-noarch, packages.
> """
> Red Hat Enterprise Linux also provides -debuginfo  packages for nearly all RPMs
> included in the operating system.
> """
> 
> 

revised as:

<quote>
Red Hat Enterprise Linux also provides -debuginfo packages for all architecture-dependent RPMs included in the operating system.
</quote>
http://brisvegas.bne.redhat.com/rhel6-devguide/debugging.html#intro.debuginfo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> Not sure if "programme" is correct US English.
> "programme" -> "program"
> 
> 

corrected (at least, the ones i could find throughout the "Debugging" chapter)
http://brisvegas.bne.redhat.com/rhel6-devguide/index-single.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> In "5.2.2. Running GDB", it's not common to write program with indentation of
> four spaces, common is to start w/o spaces
> 
> 

removed indentation at start
http://brisvegas.bne.redhat.com/rhel6-devguide/runninggdb.html

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> In this guide is mostly used file:///PATH/... not just /PATH/...
> /usr/share/doc/valgrind-version/valgrind_manual.pdf  and
> /usr/share/doc/valgrind-version/html/index.html
> + /usr/share/doc/oprofile-version/
> + /usr/share/doc/oprofile-version/oprofile.html
> + /usr/share/doc/oprofile-version/internals.html
> 

done

> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> """
> kernel-version-devel, kernel-version-debuginfo, and
> kernel-version-debuginfo-common.
> """
> kernel-2.6.32-33.el6.x86_64
> kernel-debuginfo-common-x86_64-2.6.32-37.el6.x86_64
> kernel-headers-2.6.32-37.el6.x86_64
> kernel-devel-2.6.32-33.el6.x86_64
> 
> So it's: e.g. kernel-devel-version
> 

revised as:

kernel-variant-devel-version
kernel-variant-debuginfo-common-version
kernel-variant-debuginfo-version

http://brisvegas.bne.redhat.com/rhel6-devguide/systemtap.html

> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Comment 6 releng-rhel@redhat.com 2010-11-11 15:29:07 UTC
Red Hat Enterprise Linux 6.0 is now available and should resolve
the problem described in this bug report. This report is therefore being closed
with a resolution of CURRENTRELEASE. You may reopen this bug report if the
solution does not work for you.


Note You need to log in before you can comment on or make changes to this bug.