Add markup to copr-rpmbuild man page#4333
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the formatting of the copr-rpmbuild asciidoc man page by bolding options and italicizing file paths and placeholders. The reviewer feedback suggests enhancing consistency with the SYNOPSIS section by documenting the short options (-c, -d, -r, -v, -h) alongside their corresponding long options in the OPTIONS section, as well as italicizing an additional log file path.
| *--config* _CONFIG_PATH_:: | ||
| Path to an alternative config file. By default _/etc/copr-rpmbuild/main.ini_ is used. |
There was a problem hiding this comment.
For completeness and consistency with the SYNOPSIS section, document the short option -c alongside the long option --config.
*-c*, *--config* _CONFIG_PATH_::
Path to an alternative config file. By default _/etc/copr-rpmbuild/main.ini_ is used.
| *--detached*:: | ||
| Run build in background and output the process PID. Log into /var/lib/copr-rpmbuild/main.log. |
There was a problem hiding this comment.
Document the short option -d alongside the long option --detached for completeness. Additionally, format the log file path _/var/lib/copr-rpmbuild/main.log_ in italics to maintain consistency with other file paths in the document.
*-d*, *--detached*::
Run build in background and output the process PID. Log into _/var/lib/copr-rpmbuild/main.log_.
| *--chroot* _CHROOT_NAME_:: | ||
| Name of the chroot to build for. This follows mock's convention for naming chroots (e.g. fedora-27-x86_64). See _/etc/mock_ for the full list. |
There was a problem hiding this comment.
For completeness and consistency with the SYNOPSIS section, document the short option -r alongside the long option --chroot.
*-r*, *--chroot* _CHROOT_NAME_::
Name of the chroot to build for. This follows mock's convention for naming chroots (e.g. fedora-27-x86_64). See _/etc/mock_ for the full list.
| Build RPM. This is the default action. Requires *--chroot* to be specified. | ||
|
|
||
| --verbose:: | ||
| *--verbose*:: |
There was a problem hiding this comment.
For completeness and consistency with the SYNOPSIS section, document the short option -v alongside the long option --verbose.
*-v*, *--verbose*::
| Print debugging information. | ||
|
|
||
| --help:: | ||
| *--help*:: |
There was a problem hiding this comment.
For completeness and consistency with the SYNOPSIS section, document the short option -h alongside the long option --help.
*-h*, *--help*::
|
The second commit applies the recommendations by gemini-code-assist. |
1 participant
This commit adds some minimal markup to the copr-rpmbuild man page, according to the rules in man-pages.7.