1684059 – Man page incorrectly list location of tlog-rec-session.conf as /usr/local/etc/tlog/ instead of /etc/tlog/

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 1684059 - Man page incorrectly list location of tlog-rec-session.conf as /usr/local/etc/tlog/ instead of /etc/tlog/

Summary: Man page incorrectly list location of tlog-rec-session.conf as /usr/local/etc...

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 8
Classification:	Red Hat
Component:	tlog
Sub Component:
Version:	8.0
Hardware:	All
OS:	Linux
Priority:	unspecified
Severity:	low
Target Milestone:	rc
Target Release:	8.0
Assignee:	jstephen
QA Contact:	Scott Poore
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2019-02-28 10:35 UTC by Mark Thacker
Modified:	2020-11-14 15:15 UTC (History)
CC List:	3 users (show)
Fixed In Version:
Doc Type:	If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:	2019-11-05 21:03:33 UTC
Type:	Bug
Target Upstream Version:
Embargoed:
Dependent Products:

Attachments	(Terms of Use)
Screen shot showing man page verses actual location of tlog-rec-session.conf file (102.63 KB, image/png) 2019-02-28 10:35 UTC, Mark Thacker	no flags	Details
View All

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHBA-2019:3405	0	None	None	None	2019-11-05 21:03:35 UTC

Description Mark Thacker 2019-02-28 10:35:01 UTC

Created attachment 1539420 [details]
Screen shot showing man page verses actual location of tlog-rec-session.conf file

Description of problem:
man tlog-rec-session(8) claims the following regarding the tlog configuration file : "The configuration parameters in this file override the ones  in  the system-wide configuration file /usr/local/etc/tlog/tlog-rec-session.conf."

When in fact the actual configuration file is stored in "/etc/tlog/tlog-rec-session.conf" instead.

Note that the man page appears to be identical to the upstream repo man page.


Version-Release number of selected component (if applicable): Version 5; Release 1.el8


How reproducible: 100% of the time


Steps to Reproduce:
1. man tlog
2. examine entry for tlog-rec-session.conf
3. Verify that actual .conf file is located only in /etc/tlog instead of /usr/local/etc/tlog

Actual results: Incorrect man page entry for location of configuration file.


Expected results: Correct location should be listed in man page in order for system administrators to know where to change the configuration.


Additional info:

Comment 1 jstephen 2019-05-08 17:52:37 UTC

This will be fixed in RHEL 8.1, it is a minor packaging distribution bug already fixed upstream.

Comment 3 Scott Poore 2019-06-14 15:56:27 UTC

Verified.

Version ::

tlog-6-1.el8.x86_64


Results ::

[root@rhel8-0 ~]# man tlog-rec-session|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-rec-session|cat |grep conf
       shell for a user. The actual user shell to start is retrieved from configuration or  environ‐
       Tlog-rec-session  loads  its  parameters  first  from  the  system-wide  configuration   file
       /etc/tlog/tlog-rec-session.conf,  then from the file pointed at by TLOG_REC_SESSION_CONF_FILE
       --configuration
              Output program configuration in JSON and exit.
              Specifies  the location of a configuration file to be read.  The configuration parame‐
              ters  in  this  file  override  the  ones  in  the  system-wide   configuration   file
              /etc/tlog/tlog-rec-session.conf.
              Specifies  the  configuration  text  to be read.  The configuration parameters in this
              Specifies the shell to spawn. Overrides  configuration  specified  with  TLOG_REC_SES‐
       /etc/tlog/tlog-rec-session.conf
              The system-wide configuration file
       tlog-rec-session.conf(5), tlog-rec(8), tlog-play(8)

[root@rhel8-0 ~]# man tlog-rec|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-rec|cat |grep conf
       the system-default directories output by "getconf CS_PATH", which is usually "/bin:/usr/bin".
       Tlog-rec  loads  its parameters first from the system-wide configuration file /etc/tlog/tlog-
       rec.conf, then from the file pointed at by TLOG_REC_CONF_FILE environment variable (if  set),
       --configuration
              Output program configuration in JSON and exit.
              STRING is the type of "log writer" to use for logging. The writer needs to be  config‐
              Specifies  the location of a configuration file to be read.  The configuration parame‐
              ters  in  this  file  override  the  ones  in  the  system-wide   configuration   file
              /etc/tlog/tlog-rec.conf.
              Specifies  the  configuration  text  to be read.  The configuration parameters in this
       /etc/tlog/tlog-rec.conf
              The system-wide configuration file
       tlog-rec.conf(5), tlog-rec-session(8), tlog-play(8)

[root@rhel8-0 ~]# man tlog-play|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-play|cat |grep conf
       Tlog-play  loads  its  parameters  from  the  system-wide  configuration file /etc/tlog/tlog-
       play.conf, which can be overridden with command-line options described below.
       --configuration
              Output program configuration in JSON and exit.
              reader needs to be configured using its own dedicated parameters.
       /etc/tlog/tlog-play.conf
              The system-wide configuration file
       tlog-play.conf(5), tlog-rec(8)


[root@rhel8-0 ~]# man tlog-rec-session.conf|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-rec-session.conf|cat |grep conf
tlog-rec-session.conf(5)                 File Formats Manual                tlog-rec-session.conf(5)
       tlog-rec-session.conf - tlog-rec-session configuration file
       tlog-rec-session.conf is a JSON-format configuration file for tlog-rec-session program.  Con‐
              The type of "log writer" to use for logging. The writer needs to be  configured  using
       A configuration specifying only a shell:
       A configuration enabling logging user input:
       A configuration specifying logging to a file:
Tlog                                        February 2016                   tlog-rec-session.conf(5)

[root@rhel8-0 ~]# man tlog-rec.conf|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-rec.conf|cat |grep conf
tlog-rec.conf(5)                         File Formats Manual                        tlog-rec.conf(5)
       tlog-rec.conf - tlog-rec configuration file
       tlog-rec.conf  is  a  JSON-format  configuration  file for tlog-rec program.  Contrary to the
              The type of "log writer" to use for logging. The writer needs to be  configured  using
       A configuration specifying only a reduced latency:
       A configuration enabling logging user input:
       A configuration specifying logging to a file:
Tlog                                          May 2017                              tlog-rec.conf(5)

[root@rhel8-0 ~]# man tlog-play.conf|cat |grep "/usr/local"
[root@rhel8-0 ~]# man tlog-play.conf|cat |grep conf
tlog-play.conf(5)                        File Formats Manual                       tlog-play.conf(5)
       tlog-play.conf - tlog-play configuration file
       tlog-play.conf  is  a  JSON-format configuration file for tlog-play program.  Contrary to the
              to be configured using its own dedicated parameters.
       A configuration specifying only the reader:
       A configuration specifying Elasticsearch reader, along with the base URL.
Tlog                                         March 2016                            tlog-play.conf(5)

Comment 5 errata-xmlrpc 2019-11-05 21:03:33 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-2019:3405

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