Fix some minor nits in the manual page #86
Conversation
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
rofl0r
reviewed
Feb 14, 2025
| @@ -24,8 +23,10 @@ is a multithreaded, tiny, portable SOCKS5 server with very moderate resource | |||
| usage that you can run on your remote boxes to tunnel connections through them, | |||
| if for some reason SSH doesn't cut it for you. | |||
| It is very lightweight, and very light on resources too: for every client, a | |||
| thread with a low stack size is spawned. the main process basically doesn't | |||
| consume any resources at all. It is also designed to be robust: it handles | |||
| thread with a low stack size is spawned. | |||
There was a problem hiding this comment.
what's the point of selectively making some lines short ?
There was a problem hiding this comment.
I went for a minimal-change approach: I only inserted a line break at the beginning of every sentence, I didn't change the already-existing line breaks in the middle of sentences. Let me know if you want me to also reflow the sentences so that short ones are now on a single line.
There was a problem hiding this comment.
i really don't even want to be reminded this manpage exists, even less spend any time on maintaining it. i'm already feeling that it was a bad idea to add it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
First of all, thanks a lot for writing and maintaining microsocks!
What do you think about these three commits? Two of them are trivial fixes, the third one - start sentences on a new line - is something I personally learned from my time as a FreeBSD doc committer; the FreeBSD project has a policy that mdoc manual pages should be written like that, both as a hint to the formatting software and also as a convenience when rewriting sentences: there is no need to reflow a whole paragraph that contains five or six sentences if you want to add four words to one of them.
Of course, it is your decision whether to accept these changes; let me know if you think that some of them are not needed, I can drop them from the branch.
BTW, it is great to see people writing mdoc manual pages! Over the years I have wondered why this is not more widespread; it is so much easier than using the "traditional" man macro set...
Thanks again, and keep up the great work!