Skip to content

Commit

Permalink
Capitalize references to the project
Browse files Browse the repository at this point in the history
  • Loading branch information
waveform80 committed Jun 19, 2024
1 parent cdd57ff commit 3cb4e45
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions docs/reference/units/exporter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Exporter Unit
=============

The purpose of exporter units is to provide an easy way to customize the
checkbox reports by delegating the customization bits to providers.
Checkbox reports by delegating the customization bits to providers.

Each exporter unit expresses a binding between code (the entry point) and data.
Data can be new options, different Jinja2 templates and/or new paths to load
Expand All @@ -12,8 +12,8 @@ them.
File format and location
------------------------

Exporter entry units are regular checkbox units and are contained and shipped
with checkbox providers. In other words, they are just the same as job and test
Exporter entry units are regular Checkbox units and are contained and shipped
with Checkbox providers. In other words, they are just the same as job and test
plan units, for example.

Fields
Expand Down
24 changes: 12 additions & 12 deletions docs/reference/units/job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,8 @@ Following fields may be used by the job unit:

``flags``:
(optional) This fields contains list of flags separated by spaces or
commas that might induce checkbox to run the job in particular way.
Currently, following flags are inspected by checkbox:
commas that might induce Checkbox to run the job in particular way.
Currently, following flags are inspected by Checkbox:

.. _reset-locale flag:

Expand All @@ -245,17 +245,17 @@ Following fields may be used by the job unit:
.. _win32 flag:

``win32``:
This flag makes checkbox run jobs' commands in windows-specific manner.
This flag makes Checkbox run jobs' commands in windows-specific manner.
Attach this flag to jobs that are run on Windows OS.

.. _noreturn flag:

``noreturn``:
This flag makes checkbox suspend execution after job's command is run.
This prevents scenario where checkbox continued to operate (writing
This flag makes Checkbox suspend execution after job's command is run.
This prevents scenario where Checkbox continued to operate (writing
session data to disk and so on), while other process kills it (leaving
checkbox session in unwanted/undefined state).
Attach this flag to jobs that cause killing of checkbox process during
Checkbox session in unwanted/undefined state).
Attach this flag to jobs that cause killing of Checkbox process during
their operation. E.g. run shutdown, reboot, etc.
This flag also makes Checkbox to leave a ``__checkbox_respawn`` file
in the ``$PLAINBOX_SESSION_SHARE`` directory which can be used by the
Expand All @@ -270,16 +270,16 @@ Following fields may be used by the job unit:
.. _has-leftovers flag:

``has-leftovers``:
This flag makes checkbox silently ignore (and not log) any files left
This flag makes Checkbox silently ignore (and not log) any files left
over by the execution of the command associated with a job. This flag
is useful for jobs that don't bother with maintenance of temporary
directories and just want to rely on the one already created by
checkbox.
Checkbox.

.. _simple flag:

``simple``:
This flag makes checkbox disable certain validation advice and have
This flag makes Checkbox disable certain validation advice and have
some sensible defaults for automated test cases. This simplification
is meant to cut the boiler plate on jobs that are closer to unit tests
than elaborate manual interactions.
Expand All @@ -300,15 +300,15 @@ Following fields may be used by the job unit:
.. _preserve-cwd flag:

``preserve-cwd``:
This flag makes checkbox run the job command in the current working
This flag makes Checkbox run the job command in the current working
directory without creating a temp folder (and running the command from
this temp folder). Sometimes needed on snappy
(See http://pad.lv/1618197)

.. _fail-on-resource flag:

``fail-on-resource``:
This flag makes checkbox fail the job if one of the resource
This flag makes Checkbox fail the job if one of the resource
requirements evaluates to False.

.. _also-after-suspend flag:
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/units/packaging-meta-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ provider and makes package management largely automatic.
File format and location
------------------------

Packaging meta-data units are regular checkbox units and are contained and
shipped with checkbox providers. In other words, they are just the same as job
Packaging meta-data units are regular Checkbox units and are contained and
shipped with Checkbox providers. In other words, they are just the same as job
and test plan units, for example.

Fields
Expand Down

0 comments on commit 3cb4e45

Please sign in to comment.