From 9df428e2d35b8eb0b9c9cbbfe0f7e74972f77b70 Mon Sep 17 00:00:00 2001 From: Jun Aruga Date: Fri, 3 Jan 2025 14:20:56 +0100 Subject: [PATCH] README.md: Limit lines to 80 characters. Apply semantic line breaks [1] to the texts except for breaking markdown syntax. The limitation of the 80 characters is inspired by Ruby Rubocop's style guide. [2] [1] https://sembr.org/ [2] https://github.com/rubocop/ruby-style-guide?tab=readme-ov-file#maximum-line-length --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8eacd1..77effe8 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,17 @@ $ tmt -c distro=fedora-rawhide run --all provision -h virtual -i fedora-rawhide ... ``` -The tmt's provisioning method virtual (`tmt run provision -h virtual`) must be used, otherwise the tests fail due to known issues with container provisioning method (`tmt run provision -h container`). Also note the `run-NNN` printed on the output of the command. This represents the run ID used with `tmt run --id` option in later steps. +The tmt's provisioning method virtual (`tmt run provision -h virtual`) must be +used, otherwise the tests fail due to known issues with container provisioning +method (`tmt run provision -h container`). Also note the `run-NNN` printed on +the output of the command. This represents the run ID used with `tmt run --id` +option in later steps. -Run the following command to see the report, setting the value of the above run ID to the `--id` option. As this repository doesn't have tmt's plans to run the tests, we need to set the `plans --default` to use the default plans. See [this tmt's document](https://tmt.readthedocs.io/en/stable/stories/cli.html#report) about the `tmt run report` options. +Run the following command to see the report, setting the value of the above run +ID to the `--id` option. As this repository doesn't have tmt's plans to run the +tests, we need to set the `plans --default` to use the default plans. See [this +tmt's document](https://tmt.readthedocs.io/en/stable/stories/cli.html#report) +about the `tmt run report` options. ``` $ tmt run --id run-NNN report -vvv @@ -48,8 +56,11 @@ $ tmt tests ls /systemtap-static-probes-in-ruby ``` -Run the following command to run a specific test with `-n` option to specify a regular expression to match the test name for Fedora rawhide: +Run the following command to run a specific test with `-n` option to specify a +regular expression to match the test name for Fedora rawhide: ``` -$ tmt -c distro=fedora-rawhide run --all provision -h virtual -i fedora-rawhide tests -n '^/systemtap-static-probes-in-ruby$' +$ tmt -c distro=fedora-rawhide run --all \ + provision -h virtual -i fedora-rawhide \ + tests -n '^/systemtap-static-probes-in-ruby$' ```