Commit Graph

11 Commits

Author SHA1 Message Date
Emil Velikov
c13f9d95ab man: remove erroneous " in BUGS section
A silly copy/paste mistake by yours truly (-:

Fixes: ecedc689 ("man: add BUGS section with basic information")
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/177
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-10-15 13:38:03 -05:00
Emil Velikov
8feccfc21d man/rmmod: document (how) we handle list of modules
Mention in the help and docs that rmmod operates on list of modules,
alongside its current mode of operation.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/177
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-10-15 13:38:03 -05:00
Emil Velikov
ecb77447af man: list short/long opt on same line
With earlier commit, I attempted to keep them on separate lines for
somewhat dubious reasons. In practise that didn't work and they stayed
on the same line, while also dropping the separating comma.

Looking back, it would be better to fix the vim manpager mode issues
rather than mask it. Mea culpa

Effectively this reverts commit e7626810fd

Reference: https://lore.kernel.org/linux-modules/ZvknyLKvQeBo16n9@meinfjell.helgefjelltest.de
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/164
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-10-08 23:01:50 -05:00
Emil Velikov
ecedc6890b man: add BUGS section with basic information
Link the issue tracker and recommend providing reproducer/expectations
in the bug report.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/164
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-10-08 23:01:50 -05:00
Emil Velikov
4cc728ffa0 man/rmmod: reorder, add --help
Stay consistent with the output of rmmod --help and update the
respective options.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/138
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-09-21 10:53:12 -05:00
Emil Velikov
e7626810fd man: list options one per line
Somewhat inspired by my selfish use of VIM as man pager. Namely, when
there are multiple options on the same line, only the first one gets
properly rendered.

A good bonus point is that very long instances, like modinfo's legacy
"--author, --description ..." look a bit neater now.

With this is also more consistently handle short/long options which take
an argument.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-09 00:18:21 -05:00
Emil Velikov
082617913f man: rework AUTHORS section
Replace the partial listing with suggestion to check through git
shortlog and git blame.

Explicitly spell out the current maintainer, alongside giving Jon
attribution for the original project.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-09 00:18:21 -05:00
Emil Velikov
ff38d82ede man: remove the "Maintained by" references
At a glance through my system, around 2% of the man pages include such
statement.

Looking through git log, Jon has been active in a while and presumably
have moved on.

Most importantly the Copyright section isn't the best place to reference
the maintainer/contact person.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-09 00:18:21 -05:00
Emil Velikov
e971579bba man: misc punctuation fixes
Some commas and a full stop was missing ;-)

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-09 00:18:21 -05:00
Emil Velikov
134bf30e74 man: add some extra bold/italic annotations
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-09 00:18:21 -05:00
Emil Velikov
f3a423b6d8 man: add scdoc based man pages
Working with xml is quite fiddly. Swap that for scdoc, which has very
trivial markup-like syntax.

We have opted for scdoc since it's available on practically any linux
distribution. Implementation-wise it's a trivial C99 project, at 1k LoC.

If using scdoc proves to be a burden, we can trivially port these to
pandoc or similar - 90% of the content will stay the same.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
2024-07-03 10:10:05 -05:00