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.

Sign up for GitHub

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

Jump to bottom

docs: clean up and polish the SEE ALSO sections of all man pages #11957

Closed
wants to merge 3 commits into from
Closed

docs: clean up and polish the SEE ALSO sections of all man pages #11957

wants to merge 3 commits into from

Conversation

bagder
Copy link
Member

@bagder bagder commented Sep 26, 2023

No description provided.

@github-actions github-actions bot added the tests label Sep 26, 2023
@bagder bagder mentioned this pull request Sep 26, 2023
Closed
@bagder
manpage-syntax.pl: verify SEE ALSO syntax
f7aa848 
- Enforce a single reference per .BR line
- Skip the quotes around the section number for example (3)
- Insist on trailing commas on all lines except the last
- Error on comma on the last SEE ALSO entry

- List the entries alpha-sorted, not enforced just recommended
@bagder
docs: adapt SEE ALSO sections to new requirements
445d30c
@jay
Copy link
Member

jay commented Sep 27, 2023

Skip the quotes around the section number for example (3)

Is there a documented format? I thought it was example "(3)," but probably because that's the way we've done it in the past.

@bagder
Copy link
Member Author

bagder commented Sep 27, 2023

Is there a documented format? I thought it was example "(3)," but probably because that's the way we've done it in the past.

Sure the format is documented, but its a very diverse format that allows for many different ways to do this. I landed on this updated version (which I also think is simplified) after trying what works with the man command and a little bit what makes the man page manageable to edit for us humans and also easier to check by a script.

@bagder
fixup manpage-syntax.pl to filter all CR LF
ae7da1b 
Maybe this fixes some of the windows problems?
@bagder bagder closed this in 7000a0e Sep 27, 2023
bagder added a commit that referenced this pull request Sep 27, 2023
@bagder
docs: adapt SEE ALSO sections to new requirements
bb50368 
To please manpage-syntax.pl used by test 1173

Closes #11957
@bagder bagder deleted the bagder/see-also branch September 27, 2023 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation tests
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@bagder @jay