-
Notifications
You must be signed in to change notification settings - Fork 55
Minor manpage polish, meson cleanups and man de-duplication #400
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
Open
evelikov
wants to merge
11
commits into
kmod-project:master
Choose a base branch
from
evelikov:man-polish
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Most tools don't consider the file/module name as optional, so we can drop the square brackets denoting so. Mind you, if we want to be extra pedantic - it is not required for --help, --version et al. Although that should be obvious, as we are (starting to) simplify yet enhance the documentation. Signed-off-by: Ricardo Branco <rbranco@suse.de> [Emil: drop kmod hunk, squash + commit message] Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Drop the "list of" part - we are already (somewhat) consistently using modulenames across the tree. While in here, also drop the square brackets - the modulename(s) is not an optional argument. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
In a number of places we are using ellipsis to indicate plural/multiple instances. It's not fairly consistent plus we can live without them in my opinion. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
We do so in all other manual pages, so update the outlier. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
With earlier meson versions (pre 0.50) build_by_default and install didn't have great integration. With newer meson versions, as the former is undefined the latter will control both. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
These are left overs from the autotools-side of the build system. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
With meson 0.61 we can use f strings, over the explicit .format(). Multi-line f-strings are introduced with meson 0.63, which we don't require yet, plus it's not like we have many instances. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
With the move to meson. only out-of-tree builds are allowed. As such, we can remove ~90% of the contents of our .gitignore file(s). Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
We don't need the cat + extra pipe - sed can take the input filename as an argument. This also means, we can drop the coreutils from the Alpine CI. This change is meant to ease de-duplication of the man pages - coming with a later commit. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Move the sections into a dedicated trailer.scd file, which gets added during manpage generation. Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
The section is very outdated, listing only the original author and/or copyright holder. A quick git log shows that over 20 individuals have helped. Swap the original for a more comprehensive solution (WHAT EXACTLY ... A see git log reference similar to the AUTHORS one?) Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
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.
Random collection of patches, while browsing through #397
First patch is a squash (+ drop of kmod bits) from Ricardo, the other 3 minor man page nitpicks.
The next 4 are meson/autotools yak shaving.
With the last two de-duplicating man sections + an open question how to credit the other 20 individuals in the COPYRIGHT section.
Patches can be picked individually or as a whole. Happy to split into separate PRs - let me know if you have any preferences.