jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-18 15:00:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Show correct path to BosConfig when using modern paths

Browse Source 
The BosConfig.5 man page shows the incorrect path to the BosConfig file
when modern installation paths are used.  For example, BosConfig.5 man
page distributed by Debian contains the text:

    The file must reside in the /var/lib/openafs/local directory ...

which should read:

    The file must reside in the /etc/openafs directory ...

The man page files contain Transarc-style paths which are translated to
the configured paths by the install target.  The path /usr/afs/local in
the BosConfig pod file is interpreted as @afslocaldir@, not the correct
@afsbosconfigdir@.

Change the BosConfig POD text to trigger a special substitution case in
the install-man script. This case is is already in use to correctly
translate paths of the BosConfig.new and BosConfig files the bosserver
man page.

    /usr/afs/local/BosConfig -> @afsbosconfigdir@/BosConfig

Using this rule requires a change to the text to show the fully
qualified path to the BosConfig file, instead of just the directory
name.

Change-Id: If1c5872dd86c7c1a5de98fb37daef903cd10b26b
Reviewed-on: https://gerrit.openafs.org/14908
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
This commit is contained in:
Michael Meffie 2022-02-22 14:10:36 -05:00 committed by Benjamin Kaduk
parent fad319fea2
commit b0cafad62a
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/man-pages/pod5/BosConfig.pod
View File

@ -9,8 +9,7 @@ Server monitors on its server machine, and thus defines which AFS server
processes run on the machine. It specifies how the BOS Server reacts when
a process fails, and also defines the times at which the BOS Server
automatically restarts processes as part of performance maintenance. The
file must reside in the F</usr/afs/local> directory on each AFS server
machine.
F</usr/afs/local/BosConfig> file must be present on each AFS server machine.
A server process entry in the F<BosConfig> file records the following
information: