From feddd5e7f8c6f8167b48a077fa2a5394dc008999 Mon Sep 17 00:00:00 2001 From: Brian Leung Date: Fri, 29 Jul 2022 11:13:21 -0700 Subject: [PATCH 1/2] manual: fix typos --- .../writing-nixos-tests.section.md | 34 +++++++++---------- .../writing-nixos-tests.section.xml | 15 +++----- 2 files changed, 22 insertions(+), 27 deletions(-) diff --git a/nixos/doc/manual/development/writing-nixos-tests.section.md b/nixos/doc/manual/development/writing-nixos-tests.section.md index da965ce09e3..6934bb0face 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.section.md +++ b/nixos/doc/manual/development/writing-nixos-tests.section.md @@ -347,7 +347,7 @@ import ./make-test-python.nix { ## Failing tests early {#ssec-failing-tests-early} -To fail tests early when certain invariables are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following: +To fail tests early when certain invariants are no longer met (instead of waiting for the build to time out), the decorator `polling_condition` is provided. For example, if we are testing a program `foo` that should not quit after being started, we might write the following: ```py @polling_condition @@ -369,29 +369,29 @@ with foo_running: : specifies how often the condition should be polled: - ```py - @polling_condition(seconds_interval=10) - def foo_running(): - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition(seconds_interval=10) +def foo_running(): + machine.succeed("pgrep -x foo") +``` `description` : is used in the log when the condition is checked. If this is not provided, the description is pulled from the docstring of the function. These two are therefore equivalent: - ```py - @polling_condition - def foo_running(): - "check that foo is running" - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition +def foo_running(): + "check that foo is running" + machine.succeed("pgrep -x foo") +``` - ```py - @polling_condition(description="check that foo is running") - def foo_running(): - machine.succeed("pgrep -x foo") - ``` +```py +@polling_condition(description="check that foo is running") +def foo_running(): + machine.succeed("pgrep -x foo") +``` ## Adding Python packages to the test script {#ssec-python-packages-in-test-script} diff --git a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml index 7e4af038290..d6f4f61c064 100644 --- a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml +++ b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml @@ -607,7 +607,7 @@ import ./make-test-python.nix {
Failing tests early - To fail tests early when certain invariables are no longer met + To fail tests early when certain invariants are no longer met (instead of waiting for the build to time out), the decorator polling_condition is provided. For example, if we are testing a program foo that should not @@ -635,12 +635,10 @@ with foo_running: : specifies how often the condition should be polled: - -```py + @polling_condition(seconds_interval=10) def foo_running(): machine.succeed("pgrep -x foo") -``` description @@ -650,19 +648,16 @@ def foo_running(): provided, the description is pulled from the docstring of the function. These two are therefore equivalent: - -```py + @polling_condition def foo_running(): "check that foo is running" machine.succeed("pgrep -x foo") -``` - -```py + + @polling_condition(description="check that foo is running") def foo_running(): machine.succeed("pgrep -x foo") -```
From 7b0abced8df1276663e978c31e80f941c8de6417 Mon Sep 17 00:00:00 2001 From: Brian Leung Date: Fri, 29 Jul 2022 11:38:31 -0700 Subject: [PATCH 2/2] Update .git-blame-ignore-revs with typos-fix commit --- .git-blame-ignore-revs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index c34d5b88536..15be142ef03 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -28,6 +28,9 @@ # nixos/modules/rename: Sort alphabetically 1f71224fe86605ef4cd23ed327b3da7882dad382 +# manual: fix typos +feddd5e7f8c6f8167b48a077fa2a5394dc008999 + # nixos: fix module paths in rename.nix d08ede042b74b8199dc748323768227b88efcf7c