Bug 216207 - opensm(8): OpenSM man page variables not being filled out
Summary: opensm(8): OpenSM man page variables not being filled out
Status: New
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL: https://svnweb.freebsd.org/base/head/...
Keywords:
Depends on:
Blocks:
 
Reported: 2017-01-18 01:04 UTC by Justin Clift
Modified: 2018-04-10 19:55 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Justin Clift 2017-01-18 01:04:08 UTC
Noticed a small, but repeatable bug in the OpenSM man page.

In the FILES section for the man page, it has:

******************************************************

FILES
       @OPENSM_CONFIG_DIR@/@OPENSM_CONFIG_FILE@
              default OpenSM config file.


       @OPENSM_CONFIG_DIR@/@NODENAMEMAPFILE@
              default node name map file.  See ibnetdiscover for more
              information on format.


       @OPENSM_CONFIG_DIR@/@PARTITION_CONFIG_FILE@
              default partition config file


       @OPENSM_CONFIG_DIR@/@QOS_POLICY_FILE@
              default QOS policy config file


       @OPENSM_CONFIG_DIR@/@PREFIX_ROUTES_FILE@
              default prefix routes file.

******************************************************

It seems like "OPENSM_CONFIG_DIR" (and the following tokens) should have been replaced at compile time with the correct final locations.  But weren't. ;)

Hopefully it's not too hard to fix. :)
Comment 1 Justin Clift 2017-01-18 19:50:57 UTC
As a data point, this occurs whether or not MK_OFED is defined in the kernel makeoptions. eg:

  makeoptions     WITH_MK_OFED=yes

Unlike (say) /etc/rc.d/opensm.conf, which needs the option for creation to happen.

As opensm.conf is created when WITH_MK_OFED is defined, it seems like the required variable information should be available.  It's just not getting into the man page:

  /usr/share/man/man8/opensm.8.gz