Skip to content
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

man: add manpages all binaries #5845

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions man/avocado-runner-avocado-instrumented.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-avocado-instrumented
:subtitle: nrunner application for avocado-instrumented tests
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-avocado-instrumented [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner application for avocado-instrumented tests

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-dry-run.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-dry-run
:subtitle: nrunner application for dry run
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-dry-run [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

It performs no action before reporting FINISHED status with cancel result.

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
32 changes: 32 additions & 0 deletions man/avocado-runner-exec-test.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
:title: avocado-runner-exec-test
:subtitle: nrunner application for standalone executables treated as tests
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-exec-test [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

This is similar in concept to the Avocado "SIMPLE" test type, in which an
executable returning 0 means that a test passed, and anything else means
that a test failed.

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-noop.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-noop
:subtitle: nrunner application that performs no action before reporting FINISHED status
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-noop [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

Sample runner that performs no action before reporting FINISHED status.

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
32 changes: 32 additions & 0 deletions man/avocado-runner-python-unittest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
:title: avocado-runner-python-unittest
:subtitle: nrunner application for Python unittests
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-python-unittest [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

The runnable uri is used as the test name that the native unittest
TestLoader will use to find the test. A native unittest test runner
(TextTestRunner) will be used to execute the test.

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-requirement-asset.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-requirement-asset
:subtitle: nrunner application for requirements of type asset
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

nrunner application for requirements of type asset [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner base application

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-requirement-package.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-requirement-package
:subtitle: nrunner application for requirements of type package
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-requirement-package [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner application for requirements of type package

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-sysinfo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-sysinfo
:subtitle: nrunner application for gathering sysinfo
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-sysinfo [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner application for gathering sysinfo

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner-tap.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner-tap
:subtitle: nrunner application for executable tests that produce TAP
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner-tap [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner application for executable tests that produce TAP

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
30 changes: 30 additions & 0 deletions man/avocado-runner.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:title: avocado-runner
:subtitle: nrunner base application
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-runner [-h]
{capabilities,runnable-run,runnable-run-recipe,task-run,task-run-recipe} ...

DESCRIPTION
===========

nrunner base application

OPTIONS
=======

Positional arguments::

capabilities Outputs capabilities, including runnables and commands
runnable-run Runs a runnable definition from arguments
runnable-run-recipe Runs a runnable definition from a recipe
task-run Runs a task from arguments
task-run-recipe Runs a task from a recipe

Optional arguments::

-h, --help Show this help message and exit
25 changes: 25 additions & 0 deletions man/avocado-software-manager.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
:title: avocado-software-manager
:subtitle: avocado software manager
:title_upper: AVOCADO
:manual_section: 1

SYNOPSIS
========

avocado-software-manager
{install|remove|check-installed|list-all|list-files|add-repo|remove-repo| \
upgrade|what-provides|install-what-provides}
[-h] [--verbose]

DESCRIPTION
===========

avocado software manager

OPTIONS
=======

Optional arguments::

-h, --help show this help message and exit
--verbose include debug messages in console output
Loading
Loading