docs: standardize man page trailers with AUTHORS, COPYRIGHT, and SEE ALSO#192
Merged
docs: standardize man page trailers with AUTHORS, COPYRIGHT, and SEE ALSO#192
Conversation
…ALSO Reorganize the trailing sections of all three man pages (bssh.1, bssh-keygen.1, bssh-server.8) into a consistent BUGS / AUTHORS / COPYRIGHT / SEE ALSO order matching common Unix manual conventions. Author attribution, contact email, Apache-2.0 license notice with the standard "no warranty" disclaimer, and the project homepage link are now uniform across all three pages.
inureyes
added
type:docs
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.
Summary
Standardize the trailing sections of all three man pages (
bssh.1,bssh-keygen.1,bssh-server.8) so they follow a consistent layout and provide uniform attribution and licensing information.Changes
AUTHORSheading across all pages (was a mix ofAUTHOR/AUTHORS) with the same byline:Copyright �glyph inbssh.1withCopyright (C)and add the standard "no warranty" disclaimer and explicitLicense: Apache-2.0line, matching the other two pages.Project homepage: https://github.com/lablup/bsshline at the end of each page.bssh.1: cross-reference the sibling pages (bssh-keygen(1),bssh-server(8)) inSEE ALSO.No code, behavior, or build configuration changes — documentation only.
Test plan
man -l docs/man/bssh.1renders cleanly with the new section orderman -l docs/man/bssh-keygen.1renders cleanlyman -l docs/man/bssh-server.8renders cleanly�characters remain (grep -n $'\xef\xbf\xbd' docs/man/*returns nothing)