Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[2.2] Consolidate conf file help text with man pages #333

Closed
rdmark opened this issue May 2, 2023 · 3 comments
Closed

[2.2] Consolidate conf file help text with man pages #333

rdmark opened this issue May 2, 2023 · 3 comments
Labels
netatalk2 Specific to Netatalk 2.x

Comments

@rdmark
Copy link
Member

rdmark commented May 2, 2023

netatalk2 has the bad habit of documenting configuration options in both the conf files themselves and in the man pages. It's ideal to have just one source of truth, I think. Right now there are discrepancies between the two, plus the ongoing overhead of having to edit both when you make updates...

@rdmark
Copy link
Member Author

rdmark commented May 2, 2023

I propose removing all the help text in conf files, and folding it into the man pages.

@rdmark
Copy link
Member Author

rdmark commented May 4, 2023

PR ready that does this for afpd.conf and AppleVolumes.default.conf; the other files don't need immediate attention I think.

I also touched up the related man pages for those two files as I went through and checked that all conf file documentation is reflected in the man pages. I only found one that wasn't: illegalseq in AppleVolumes. I'll do some research to understand if it is a deprecated option or a gap in documentation.

@rdmark
Copy link
Member Author

rdmark commented May 5, 2023

Turns out the illegalseq option was added in 2.0.4 but never documented in the AppleVolumes man page, only the conf file. Pushed a commit to add documentation.

@rdmark rdmark added the netatalk2 Specific to Netatalk 2.x label May 15, 2023
@rdmark rdmark closed this as completed Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
netatalk2 Specific to Netatalk 2.x
Projects
None yet
Development

No branches or pull requests

1 participant