-
Notifications
You must be signed in to change notification settings - Fork 281
pkg.conf(5) BACKUP_LIBRARIES, BACKUP_LIBRARY_PATH #2440
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
base: main
Are you sure you want to change the base?
Conversation
Punctuation; uppercase beginnings to sentences; and 'define by' should be 'defined by'. Whilst here, aim to make the section a little clearer.
The section for BACKUP_LIBRARIES uses the word 'path'. Consistency: the same word may be used here.
Clarity: 'backup the library to' is less ambiguous than 'backup the library at'.
.Qq compat-libraries | ||
will be created. the version will be bumped each time a new library is backed up | ||
package. The package version will be bumped whenever an additional library is backed up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package. The package version will be bumped whenever an additional library is backed up. | |
package. The package version will increase whenever an additional library is backed up. |
Avoiding the word bump, because it seems not well-suited to changes such as 20250322165541
up to 20250325164747
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, the way you have it in the patch currently is an improvement.
.Qq compat-libraries | ||
will be created. the version will be bumped each time a new library is backed up | ||
package. The package version will be bumped whenever an additional library is backed up. | ||
Default: NO. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Default: NO. | |
Default: false. |
Boolean pairings:
true
orfalse
YES
orNO
– true
or NO
sounds a little strange.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. The whole page uses "YES" and "NO" consistently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The patch as it is currently is an improvement. Please squash your commits since this is one logical change, with a self explanatory commit message like:
pkg.conf.5: Wordsmith BACKUP_LIBRARY
Thanks Graham!
.Qq compat-libraries | ||
will be created. the version will be bumped each time a new library is backed up | ||
package. The package version will be bumped whenever an additional library is backed up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, the way you have it in the patch currently is an improvement.
.Qq compat-libraries | ||
will be created. the version will be bumped each time a new library is backed up | ||
package. The package version will be bumped whenever an additional library is backed up. | ||
Default: NO. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. The whole page uses "YES" and "NO" consistently.
.Qq compat-libraries | ||
will be created. the version will be bumped each time a new library is backed up | ||
package. The package version will be bumped whenever an additional library is backed up. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package. The package version will be bumped whenever an additional library is backed up. | |
package. | |
The package version will be bumped whenever an additional library is | |
backed up. |
Sorry to backtrack, I forgot something! Roff requires one sentence per line, and please wrap at 72 for compatibility with standardized methodology and tooling in base. After that, LGTM!
Minor corrections:
Whilst here, aim to make the sections a little clearer and more consistent.