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

Rework pkg-set.8 #2076

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pauamma
Copy link
Contributor

@pauamma pauamma commented Oct 5, 2022

  • Reorganize synopsis to pair short and long options

  • Mark exclusive options as such

  • Add missing --vital synonym for -v

  • Reorder sections to pacify mandoc -T lint

  • Copyedit and fix markup throughout

- Reorganize synopsis to pair short and long options

- Mark exclusive options as such

- Add missing --vital synonym for -v

- Reorder sections to pacify mandoc -T lint

- Copyedit and fix markup throughout
@pauamma
Copy link
Contributor Author

pauamma commented Oct 5, 2022

Planning to go over all manual pages. Will mark as mergeable when done.

@0mp
Copy link
Member

0mp commented Oct 6, 2022

Hey Pau Amma, thanks for working on the manual pages.

I’d like to suggest dropping the long options from the synopsis entirely for readability. See #2027. This way it would also be less editing work for you.

@vstakhov
Copy link
Member

vstakhov commented Oct 6, 2022

I'm not even sure if there is any useful outcome of just listing all possible options and arguments (especially optional ones) in the same place. Short options only are totally useless as they provide no information about what they do. Long options are, indeed, messy... So a format like pkg set <mandatory_arguments_and_options> [OPTIONS] look more sane: we define the mandatory long/short options/arguments and hide everything else in that [OPTIONS] block, describing all those options later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants