Skip to content

Suggestion: Template the mandocs and use correct paths according to build options #17437

Open
@dodexahedron

Description

@dodexahedron

Describe the feature would like to see added to OpenZFS

The mandocs make plenty of references to files in various locations, some of which are dependent on build configuration.

For example, zpool-features(7) tells you where to find the pre-made pool compat files.

However, those paths are likely to be incorrect for builds from source, including DKMS builds, as the default location in those cases is in /usr/local/share/zfs, not /usr/share/zfs.

Distro-provided builds also very rarely scrub mandocs for things like that in packages, and zfs is no exception to that.

Perhaps they could be templated and the values given to autoconf could be substituted where appropriate?

How will this feature improve OpenZFS?

Would solve minor inaccuracies in mandocs.

Would be an improvement to documentation, particularly helpful to users who either don't realize or simply forgot to consider that things may be in local - especially if they built it a long time ago.

Additional context

Autoconf itself could probably be used to automate the token replacement, I imagine. Or even just the makefile recipes for docs. 🤷‍♂

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: FeatureFeature request or new feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions