Skip to content

Rearrange man page#248

Closed
tqdv wants to merge 2 commits intologrotate:masterfrom
tqdv:rearrange-man
Closed

Rearrange man page#248
tqdv wants to merge 2 commits intologrotate:masterfrom
tqdv:rearrange-man

Conversation

@tqdv
Copy link
Contributor

@tqdv tqdv commented Apr 11, 2019

Changes:

  • Rearrange the configuration file directives into sections
  • Rearrange and group the commandline options

I rearranged the man page so that it isn't just an alphabetically sorted list of options and directives. This should make it easier for people skimming the man page to find what they need.

Though, I'm not entirely sure about the subsection titles.

tqdv added 2 commits April 11, 2019 02:36
- Make configuration file directives a section
- Group configuration directives into groups and title the subsections
appropriately

Although a alphabetically-sorted list is good enough, regrouping them
semantically helps with clarity.
- Group the options by type

It makes finding what you need easier and faster.
@kdudka
Copy link
Member

kdudka commented Apr 11, 2019

I like the idea of having the description of configuration directives structured.

@glensc What is your opinion on this?

@glensc
Copy link
Collaborator

glensc commented Apr 11, 2019

I think good change, subsection titles are also okay.

@kdudka
Copy link
Member

kdudka commented Apr 12, 2019

OK, merging. @tqdv Thanks for the contribution!

@kdudka kdudka closed this in b10f7b6 Apr 12, 2019
kdudka pushed a commit that referenced this pull request Apr 12, 2019
- Group the options by type

It makes finding what you need easier and faster.

Closes #248
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