pages/*: describe dry-run examples as "Simulate" (#24325)

Co-authored-by: open-source-learner <315730032+open-source-learner@users.noreply.github.com>
2026-10-30 18:53:35 +08:00 · 2026-09-27 20:00:16 +02:00
parent de6ca08a53
commit bb648e8a0a
46 changed files with 46 additions and 46 deletions
@@ -23,7 +23,7 @@

 `argocd app set {{app_name}} --sync-policy auto --auto-prune --self-heal`

- Preview app synchronization without affecting cluster:
+- Simulate app synchronization, including pruning, without affecting the cluster:

 `argocd app sync {{app_name}} --dry-run --prune`

@@ -24,6 +24,6 @@

 `aws s3 rm s3://{{bucket}}/{{path/to/file}}`

- Preview changes only:
+- Simulate a command without making any changes:

 `aws s3 {{any_command}} --dryrun`
@@ -7,6 +7,6 @@

 `brew autoremove`

- Print what would be removed, but don't actually remove anything:
+- Simulate removing unused formulae, printing what would be removed:

 `brew autoremove {{[-n|--dry-run]}}`
@@ -11,7 +11,7 @@

 `brew cleanup {{formula|cask}}`

- Show what would be removed, but do not actually remove anything:
+- Simulate the cleanup, showing what would be removed:

 `brew cleanup {{[-n|--dry-run]}}`

@@ -11,6 +11,6 @@

 `brew install {{[-s|--build-from-source]}} {{formula}}`

- Download the manifest, print what would be installed but don't actually install anything:
+- Simulate an installation, downloading the manifest, and printing what would be installed:

 `brew install {{[-n|--dry-run]}} {{formula|cask}}`
@@ -11,7 +11,7 @@

 `brew upgrade {{formula|cask}}`

- Print what would be upgraded, but don't actually upgrade anything:
+- Simulate an upgrade, printing what would be upgraded:

 `brew upgrade {{[-n|--dry-run]}}`

@@ -7,7 +7,7 @@

 `bun pm pack`

- Run all steps without writing the tarball to disk:
+- Simulate packing, running all steps without writing the tarball to disk:

 `bun pm pack --dry-run`

@@ -8,7 +8,7 @@

 `cargo publish`

- Perform checks, create a `.crate` file but don't upload it (equivalent of `cargo package`):
+- Simulate publishing, performing checks, and creating a `.crate` file without uploading it (equivalent of `cargo package`):

 `cargo publish {{[-n|--dry-run]}}`

@@ -7,7 +7,7 @@

 `cargo update`

- Display what would be updated, but don't actually write the lockfile:
+- Simulate an update, displaying what would be updated without writing the lockfile:

 `cargo update {{[-n|--dry-run]}}`

@@ -8,7 +8,7 @@

 `detox {{path/to/file}}`

- Show how detox would rename all the files in a directory tree:
+- Simulate renaming all the files in a directory tree, showing how they would be renamed:

 `detox {{[-n|--dry-run]}} -r {{path/to/directory}}`

@@ -7,7 +7,7 @@

 `git clean {{[-i|--interactive]}}`

- Show which files would be deleted without actually deleting them:
+- Simulate the cleanup, showing which files would be deleted:

 `git clean {{[-n|--dry-run]}}`

@@ -4,7 +4,7 @@
 > This command is often not used directly but as an internal command that is used by Git gc.
 > More information: <https://git-scm.com/docs/git-prune>.

- Report what would be removed by Git prune without removing it:
+- Simulate pruning, reporting what would be removed:

 `git prune {{[-n|--dry-run]}}`

@@ -19,6 +19,6 @@

 `hg add {{[-S|--subrepos]}}`

- Perform a test-run without performing any actions:
+- Simulate adding files without performing any actions:

 `hg add {{[-n|--dry-run]}}`
@@ -7,7 +7,7 @@

 `hledger import {{path/to/bank.csv}}`

- Show what would be imported from these two files, without doing anything:
+- Simulate importing from these two files, showing what would be imported:

 `hledger import {{path/to/bank1.csv}} {{path/to/bank2.csv}} --dry-run`

@@ -32,6 +32,6 @@

 `jj gerrit upload --quiet`

- Preview what would be uploaded without pushing to Gerrit:
+- Simulate an upload, showing what would be uploaded without pushing to Gerrit:

 `jj gerrit upload {{[-n|--dry-run]}}`
@@ -12,7 +12,7 @@

 `kubectl run {{nginx-dev}} --image nginx --env "{{TEST_VAR}}={{testing}}"`

- Show API calls that would be made to create an `nginx` container:
+- Simulate creating an `nginx` container, showing the API calls that would be made:

 `kubectl run {{nginx-dev}} --image nginx --dry-run={{none|server|client}}`

@@ -7,7 +7,7 @@

 `ng {{[n|new]}} {{app_name}}`

- Preview the actions without creating files:
+- Simulate creating a new app, showing the actions without creating files:

 `ng {{[n|new]}} {{app_name}} {{[-d|--dry-run]}}`

@@ -12,7 +12,7 @@

 `npm prune --production`

- Show what would be removed without making any changes:
+- Simulate pruning, showing what would be removed without making any changes:

 `npm prune --dry-run`

@@ -15,7 +15,7 @@

 `opencode uninstall {{[-d|--keep-data]}}`

- Show what would be removed without removing:
+- Simulate uninstalling, showing what would be removed:

 `opencode uninstall --dry-run`

@@ -11,7 +11,7 @@

 `php-cs-fixer fix {{path/to/directory}}`

- Execute code style linting without applying changes:
+- Simulate fixing code style, reporting issues without applying changes:

 `php-cs-fixer fix --dry-run`

@@ -23,6 +23,6 @@

 `pio system prune --cache`

- List unused PlatformIO data that would be removed but do not actually remove it:
+- Simulate pruning, listing unused PlatformIO data that would be removed:

 `pio system prune --dry-run`
@@ -11,6 +11,6 @@

 `pio update --core-packages`

- Check for new versions of packages, platforms, and libraries but do not actually update them:
+- Simulate an update, checking for new versions of packages, platforms, and libraries without updating them:

 `pio update --dry-run`
@@ -17,6 +17,6 @@

 `poetry version --next-phase`

- Test project stage function without writing to `pyproject.toml`:
+- Simulate bumping the version to a given stage without writing to `pyproject.toml`:

 `poetry version {{stage}} --dry-run`
@@ -7,7 +7,7 @@

 `sfdk scrape`

- Preview the list of commits to be scrapped:
+- Simulate saving modifications as patches, listing the commits that would be converted:

 `sfdk scrape {{[-n|--dry-run]}}`

@@ -31,6 +31,6 @@

 `standard-version --infile {{path/to/file.md}}`

- Display the release that would be performed without performing them:
+- Simulate a release, displaying what would be performed:

 `standard-version --dry-run`
@@ -9,7 +9,7 @@

 `tarsnap -c --keyfile {{path/to/key_file}} --cachedir {{path/to/cache_directory}} -f {{archive_name}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}`

- Display how much data would be uploaded:
+- Simulate creating an archive, displaying how much data would be uploaded:

 `tarsnap -c --dry-run --print-stats --keyfile {{path/to/key_file}} --cachedir {{path/to/cache_directory}} -f {{archive_name}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}`

@@ -15,7 +15,7 @@

 `uv lock --check-exists`

- Preview what would be locked without writing the lockfile:
+- Simulate locking, showing what would be locked without writing the lockfile:

 `uv lock --dry-run`

@@ -11,7 +11,7 @@

 `uv self update {{0.4.0}}`

- Check for available `uv` updates without installing:
+- Simulate an update, checking for available `uv` updates without installing them:

 `uv self update --dry-run`

@@ -31,6 +31,6 @@

 `uv sync --check`

- Preview what would be synced without making changes:
+- Simulate syncing, showing what would be synced without making changes:

 `uv sync --dry-run`
@@ -15,7 +15,7 @@

 `uv version --bump {{major|minor|patch}}`

- Preview version changes without writing to `pyproject.toml`:
+- Simulate a version bump without writing to `pyproject.toml`:

 `uv version --bump {{patch}} --dry-run`

@@ -27,7 +27,7 @@

 `apptainer cache clean {{[-D|--days]}} {{days}}`

- Preview what would be cleaned without removing anything:
+- Simulate cleaning the cache, showing what would be removed:

 `apptainer cache clean {{[-n|--dry-run]}}`

@@ -7,7 +7,7 @@

 `archinstall`

- Start the interactive installer and generate a configuration file instead of installing:
+- Simulate an installation, going through the interactive installer, and generating a configuration file without installing:

 `archinstall --dry-run`

@@ -7,7 +7,7 @@

 `sudo btrfs {{[rest|restore]}} {{path/to/btrfs_device}} {{path/to/target_directory}}`

- List (don't write) files to be restored from a btrfs filesystem:
+- Simulate a restore, listing the files that would be restored from a btrfs filesystem:

 `sudo btrfs {{[rest|restore]}} {{[-D|--dry-run]}} {{path/to/btrfs_device}} {{path/to/target_directory}}`

@@ -15,7 +15,7 @@

 `dex {{[-a|--autostart]}} {{[-e|--environment]}} {{GNOME}}`

- Preview the programs would be executed in a regular autostart:
+- Simulate a regular autostart, showing the programs that would be executed:

 `dex {{[-a|--autostart]}} {{[-d|--dry-run]}}`

@@ -7,6 +7,6 @@

 `growpart {{/dev/sdX}} {{n}}`

- Show what modifications would be made when growing partition `n` in a disk image:
+- Simulate growing partition `n` in a disk image, showing what modifications would be made:

 `growpart {{[-N|--dry-run]}} /{{path/to/disk.img}} {{n}}`
@@ -11,7 +11,7 @@

 `lvm_import_vdo {{[-n|--name]}} {{vg_name/lv_name}} {{/dev/mapper/vdo_volume}}`

- Show what would be done without changing anything:
+- Simulate the import, showing what would be done without changing anything:

 `lvm_import_vdo --dry-run {{/dev/mapper/vdo_volume}}`

@@ -4,7 +4,7 @@
 > See also: `kmod`.
 > More information: <https://manned.org/modprobe>.

- Pretend to load a module into the kernel, but don't actually do it:
+- Simulate loading a module into the kernel:

 `modprobe {{[-n|--dry-run]}} {{module_name}}`

@@ -17,6 +17,6 @@

 `sudo run_init {{[-t|--type]}} {{context_type}} {{path/to/script}}`

- Display the context that would be used without running the script:
+- Simulate running a script, displaying the context that would be used:

 `sudo run_init {{[-n|--dry-run]}} {{path/to/script}}`
@@ -9,7 +9,7 @@

 `systemd-repart`

- View changes without applying:
+- Simulate repartitioning, showing the changes without applying them:

 `systemd-repart --dry-run yes`

@@ -8,7 +8,7 @@

 `systemd-sysusers {{path/to/file}}`

- Process configuration files and print what would be done without actually doing anything:
+- Simulate processing configuration files, printing what would be done:

 `systemd-sysusers --dry-run {{path/to/file}}`

@@ -16,7 +16,7 @@

 `sudo upgradepkg --reinstall {{path/to/package.tgz}}`

- Preview what would happen without actually upgrading:
+- Simulate an upgrade, showing what would happen:

 `upgradepkg --dry-run {{path/to/package.tgz}}`

@@ -17,7 +17,7 @@

 `sudo virt-sysprep {{[-a|--add]}} {{path/to/image.qcow2}}`

- Specify a virtual machine by its name and run all enabled operations but don't actually apply the changes:
+- Simulate running all enabled operations on a virtual machine specified by its name:

 `sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} {{[-n|--dry-run]}}`

@@ -11,7 +11,7 @@

 `mole clean`

- Preview cleanup without making changes:
+- Simulate the cleanup without making changes:

 `mole clean --dry-run`

@@ -28,7 +28,7 @@

 `Clear-History -Id ({{start_id}}..{{end_id}})`

- Show what would be deleted:
+- Simulate clearing the history, showing what would be deleted:

 `Clear-History -WhatIf`

@@ -11,6 +11,6 @@

 `Expand-Archive -Path {{path\to\example.zip}} -DestinationPath {{path\to\extracted_files}} -Force`

- Preview without extracting:
+- Simulate extracting an archive without extracting anything:

 `Expand-Archive -Path {{path\to\example.zip}} -DestinationPath {{path\to\extracted_files}} -WhatIf`
@@ -8,7 +8,7 @@

 `Start-Service -Name {{service_name}}`

- Display information without starting a service:
+- Simulate starting a service, displaying what would happen:

 `Start-Service -DisplayName *{{name}}* -WhatIf`