Open
Conversation
Readers expect to jump to the FILES section specified in mdoc(7) when looking for files. Create this section and add the spool directory to it so they can find it faster.
Add mentioned paths to the whatis database by converting parentheticals to use the parenthesis macros. Convert all of them consistently while here. Silence linter warnings by escaping delimiters.
I want to do this in FreeBSD, does upstream want it too?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi!
I would like to add a FILES section to dma(8) explaning where the mail spool is. FILES is a standard section, is it makes it more predictable when you want to open the page and jump right to what you're looking for.
While here, I like to keep track of when everything was added to FreeBSD with the HISTORY section. Can I upstream this?
Also, I improved the markup to quiet the linter, and add the mentioned paths to the whatis database. This allows BSD users to instantly find the manual referencing a directory like
apropos Pa=spool/dma, offline and with no telemetry :)Thanks for dma, it's easy to use and I'm using it for a long time!