Bug 1684059
| Summary: | Man page incorrectly list location of tlog-rec-session.conf as /usr/local/etc/tlog/ instead of /etc/tlog/ | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Red Hat Enterprise Linux 8 | Reporter: | Mark Thacker <mthacker> | ||||
| Component: | tlog | Assignee: | jstephen | ||||
| Status: | CLOSED ERRATA | QA Contact: | Scott Poore <spoore> | ||||
| Severity: | low | Docs Contact: | |||||
| Priority: | unspecified | ||||||
| Version: | 8.0 | CC: | jstephen, nikolai.kondrashov, spoore | ||||
| Target Milestone: | rc | Flags: | pm-rhel:
mirror+
|
||||
| Target Release: | 8.0 | ||||||
| Hardware: | All | ||||||
| OS: | Linux | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2019-11-05 21:03:33 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: | |||||||
| Attachments: |
|
||||||
This will be fixed in RHEL 8.1, it is a minor packaging distribution bug already fixed upstream. 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)
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 |
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: