db/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-03-03 14:52:21 +02:00
Code Issues Releases Activity

Remove user-facing documentation references to --vm=none.

Browse Source 
This parameter is now optional and defaults to none so there is no reason to explicitly show it in user-facing documentation.

Also make the vm parameter in ci.pl optional to be consistent with how test.pl behaves.
This commit is contained in:
David Steele 2023-05-23 10:58:51 +03:00
parent 4ec51cdb2f
commit c633b187db
5 changed files with 18 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.cirrus.yml
View File

@ -25,7 +25,7 @@ arm64_task:
- chown -R testuser ${CIRRUS_WORKING_DIR?} - chown -R testuser ${CIRRUS_WORKING_DIR?}
script: script:
- su - testuser -c "${CIRRUS_WORKING_DIR?}/test/ci.pl test --vm=none --sudo --no-tempfs --param=c-only --param=no-coverage" - su - testuser -c "${CIRRUS_WORKING_DIR?}/test/ci.pl test --sudo --no-tempfs --param=c-only --param=no-coverage"
# FreeBSD 12 # FreeBSD 12
# ---------------------------------------------------------------------------------------------------------------------------------- # ----------------------------------------------------------------------------------------------------------------------------------
@ -38,7 +38,7 @@ freebsd_12_task:
install_script: pkg update && pkg upgrade -y libiconv && pkg install -y bash git postgresql-libpqxx pkgconf libxml2 gmake perl5 libyaml p5-YAML-LibYAML rsync meson install_script: pkg update && pkg upgrade -y libiconv && pkg install -y bash git postgresql-libpqxx pkgconf libxml2 gmake perl5 libyaml p5-YAML-LibYAML rsync meson
script: script:
- cd .. && perl ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --make-cmd=gmake --vm=none --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup - cd .. && perl ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --make-cmd=gmake --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup
debug_script: debug_script:
- ls -lah ${CIRRUS_WORKING_DIR} - ls -lah ${CIRRUS_WORKING_DIR}
@ -55,7 +55,7 @@ freebsd_13_task:
script: script:
- rsync --version - rsync --version
- cd .. && perl ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --make-cmd=gmake --vm=none --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup - cd .. && perl ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --make-cmd=gmake --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup
debug_script: debug_script:
- ls -lah ${CIRRUS_WORKING_DIR} - ls -lah ${CIRRUS_WORKING_DIR}
@ -76,7 +76,7 @@ macos_ventura_task:
- brew install -q pkg-config openssl@1.1 libpq libxml2 libyaml meson - brew install -q pkg-config openssl@1.1 libpq libxml2 libyaml meson
script: script:
- cd .. && ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --vm=none --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup - cd .. && ${CIRRUS_WORKING_DIR}/test/test.pl --min-gen --vm-max=2 --no-coverage --no-valgrind --module=command --test=backup
debug_script: debug_script:
- ls -lah ${CIRRUS_WORKING_DIR} - ls -lah ${CIRRUS_WORKING_DIR}

6
.github/workflows/test.yml vendored
View File

@ -100,8 +100,8 @@ jobs:
run: | run: |
git config --global --add safe.directory ${GITHUB_WORKSPACE?}/pgbackrest git config --global --add safe.directory ${GITHUB_WORKSPACE?}/pgbackrest
${GITHUB_WORKSPACE?}/pgbackrest/test/test.pl --vm=none --min-gen --no-valgrind --no-coverage --no-optimize --build-max=2 --module=command --test=backup ${GITHUB_WORKSPACE?}/pgbackrest/test/test.pl --min-gen --no-valgrind --no-coverage --no-optimize --build-max=2 --module=command --test=backup
${GITHUB_WORKSPACE?}/pgbackrest/test/test.pl --vm=none --min-gen --no-valgrind --no-coverage --no-optimize --build-max=2 --module=postgres --test=interface ${GITHUB_WORKSPACE?}/pgbackrest/test/test.pl --min-gen --no-valgrind --no-coverage --no-optimize --build-max=2 --module=postgres --test=interface
# Run meson unity build to check for errors, unused functions, and externed functions # Run meson unity build to check for errors, unused functions, and externed functions
unity: unity:
@ -139,7 +139,7 @@ jobs:
- name: Check - name: Check
run: | run: |
cd ${HOME?} && ${GITHUB_WORKSPACE?}/pgbackrest/test/ci.pl test --vm=none --param=code-format-check cd ${HOME?} && ${GITHUB_WORKSPACE?}/pgbackrest/test/ci.pl test --param=code-format-check
codeql: codeql:
runs-on: ubuntu-latest runs-on: ubuntu-latest

10
CONTRIBUTING.md
View File

@ -227,11 +227,11 @@ pgbackrest/doc/doc.pl --help
#### Without Docker #### Without Docker
If Docker is not installed, then the available tests can be listed using `--vm=none`, and each test must then be run with `--vm=none`. If Docker is not installed, then the available tests can be listed using `--dry-run`. Some tests require containers and will only be available when Docker is installed.
pgbackrest-dev => List tests that don't require a container pgbackrest-dev => List tests that don't require a container
``` ```
pgbackrest/test/test.pl --vm=none --dry-run pgbackrest/test/test.pl --dry-run
--- output --- --- output ---
@ -249,7 +249,7 @@ pgbackrest/test/test.pl --vm=none --dry-run
pgbackrest-dev => Run a test pgbackrest-dev => Run a test
``` ```
pgbackrest/test/test.pl --vm=none --vm-out --module=common --test=wait pgbackrest/test/test.pl --vm-out --module=common --test=wait
--- output --- --- output ---
@ -306,7 +306,7 @@ An entire module can be run by using only the `--module` option.
pgbackrest-dev => Run a module pgbackrest-dev => Run a module
``` ```
pgbackrest/test/test.pl --vm=none --module=postgres pgbackrest/test/test.pl --module=postgres
--- output --- --- output ---
@ -661,7 +661,7 @@ pgbackrest/test/test.pl --module=command --test=help --vm-out
``` ```
To verify the `help` command output, build the pgBackRest executable: To verify the `help` command output, build the pgBackRest executable:
``` ```
pgbackrest/test/test.pl --vm=none --build-only pgbackrest/test/test.pl --build-only
``` ```
Use the pgBackRest executable to test the help output: Use the pgBackRest executable to test the help output:
``` ```

10
doc/xml/contributing.xml
View File

@ -344,13 +344,13 @@ pgbackrest/doc/doc.pl --help
<section id="without-docker"> <section id="without-docker">
<title>Without Docker</title> <title>Without Docker</title>
<p>If <proper>Docker</proper> is not installed, then the available tests can be listed using <setting>--vm=none</setting>, and each test must then be run with <setting>--vm=none</setting>.</p> <p>If <proper>Docker</proper> is not installed, then the available tests can be listed using <setting>--dry-run</setting>. Some tests require containers and will only be available when Docker is installed.</p>
<execute-list host="{[host-contrib]}"> <execute-list host="{[host-contrib]}">
<title>List tests that don't require a container</title> <title>List tests that don't require a container</title>
<execute output="y"> <execute output="y">
<exe-cmd>pgbackrest/test/test.pl --vm=none --dry-run</exe-cmd> <exe-cmd>pgbackrest/test/test.pl --dry-run</exe-cmd>
<exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra> <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
<exe-highlight>[0-9]+ tests selected|DRY RUN COMPLETED SUCCESSFULLY</exe-highlight> <exe-highlight>[0-9]+ tests selected|DRY RUN COMPLETED SUCCESSFULLY</exe-highlight>
</execute> </execute>
@ -360,7 +360,7 @@ pgbackrest/doc/doc.pl --help
<title>Run a test</title> <title>Run a test</title>
<execute output="y"> <execute output="y">
<exe-cmd>pgbackrest/test/test.pl --vm=none --vm-out --module=common --test=wait</exe-cmd> <exe-cmd>pgbackrest/test/test.pl --vm-out --module=common --test=wait</exe-cmd>
<exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra> <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
</execute> </execute>
</execute-list> </execute-list>
@ -371,7 +371,7 @@ pgbackrest/doc/doc.pl --help
<title>Run a module</title> <title>Run a module</title>
<execute output="y"> <execute output="y">
<exe-cmd>pgbackrest/test/test.pl --vm=none --module=postgres</exe-cmd> <exe-cmd>pgbackrest/test/test.pl --module=postgres</exe-cmd>
<exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra> <exe-cmd-extra>{[test-cmd-extra]}</exe-cmd-extra>
</execute> </execute>
</execute-list> </execute-list>
@ -759,7 +759,7 @@ pgbackrest/test/test.pl --module=command --test=help --vm-out
<p>To verify the <cmd>help</cmd> command output, build the <backrest/> executable:</p> <p>To verify the <cmd>help</cmd> command output, build the <backrest/> executable:</p>
<code-block> <code-block>
pgbackrest/test/test.pl --vm=none --build-only pgbackrest/test/test.pl --build-only
</code-block> </code-block>
<p>Use the <backrest/> executable to test the help output:</p> <p>Use the <backrest/> executable to test the help output:</p>

8
test/ci.pl
View File

@ -56,7 +56,7 @@ test.pl [options] doc|test
#################################################################################################################################### ####################################################################################################################################
# Command line parameters # Command line parameters
#################################################################################################################################### ####################################################################################################################################
my $strVm; my $strVm = "none";
my @stryParam; my @stryParam;
my $bNoTempFs; my $bNoTempFs;
my $bSudo; my $bSudo;
@ -119,12 +119,6 @@ eval
pod2usage(); pod2usage();
} }
# VM must be defined
if (!defined($strVm))
{
confess &log(ERROR, '--vm is required');
}
################################################################################################################################ ################################################################################################################################
# Paths # Paths
################################################################################################################################ ################################################################################################################################