Skip to content

Commit

Permalink
minor spelling and grammar fixes (#1318)
Browse files Browse the repository at this point in the history
  • Loading branch information
cristihcd committed Sep 28, 2021
1 parent d56b935 commit d9c1bd0
Show file tree
Hide file tree
Showing 30 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion cli/cli_progress.go
Expand Up @@ -27,7 +27,7 @@ type progressFlags struct {

func (p *progressFlags) setup(svc appServices, app *kingpin.Application) {
app.Flag("progress", "Enable progress bar").Hidden().Default("true").BoolVar(&p.enableProgress)
app.Flag("progress-update-interval", "How ofter to update progress information").Hidden().Default("300ms").DurationVar(&p.progressUpdateInterval)
app.Flag("progress-update-interval", "How often to update progress information").Hidden().Default("300ms").DurationVar(&p.progressUpdateInterval)
p.out.setup(svc)
}

Expand Down
2 changes: 1 addition & 1 deletion cli/command_benchmark_splitters.go
Expand Up @@ -30,7 +30,7 @@ func (c *commandBenchmarkSplitters) setup(svc appServices, parent commandParent)
cmd.Flag("rand-seed", "Random seed").Default("42").Int64Var(&c.randSeed)
cmd.Flag("data-size", "Size of a data to split").Default("32MB").BytesVar(&c.blockSize)
cmd.Flag("block-count", "Number of data blocks to split").Default("16").IntVar(&c.blockCount)
cmd.Flag("print-options", "Print out fastest dynamic splitter option").BoolVar(&c.printOption)
cmd.Flag("print-options", "Print out the fastest dynamic splitter option").BoolVar(&c.printOption)

cmd.Action(svc.noRepositoryAction(c.run))

Expand Down
2 changes: 1 addition & 1 deletion cli/command_index_inspect.go
Expand Up @@ -22,7 +22,7 @@ type commandIndexInspect struct {
}

func (c *commandIndexInspect) setup(svc appServices, parent commandParent) {
cmd := parent.Command("inspect", "Inpect index blob")
cmd := parent.Command("inspect", "Inspect index blob")
cmd.Flag("all", "Inspect all index blobs in the repository, including inactive").BoolVar(&c.all)
cmd.Flag("active", "Inspect all active index blobs").BoolVar(&c.active)
cmd.Flag("content-id", "Inspect all active index blobs").StringsVar(&c.contentIDs)
Expand Down
2 changes: 1 addition & 1 deletion cli/command_logs_session.go
Expand Up @@ -33,7 +33,7 @@ type logSelectionCriteria struct {
func (c *logSelectionCriteria) setup(cmd *kingpin.CmdClause) {
cmd.Flag("all", "Show all logs").BoolVar(&c.all)
cmd.Flag("latest", "Include last N logs").Short('n').IntVar(&c.latest)
cmd.Flag("younger-than", "Include logs yonger than X (e.g. '1h')").DurationVar(&c.youngerThan)
cmd.Flag("younger-than", "Include logs younger than X (e.g. '1h')").DurationVar(&c.youngerThan)
cmd.Flag("older-than", "Include logs older than X (e.g. '1h')").DurationVar(&c.olderThan)
}

Expand Down
2 changes: 1 addition & 1 deletion cli/command_logs_show.go
Expand Up @@ -54,7 +54,7 @@ func (c *commandLogsShow) run(ctx context.Context, rep repo.DirectRepository) er
// by default show latest one
if !c.crit.any() {
sessions = sessions[len(sessions)-1:]
log(ctx).Infof("Showing latest log (%v)", formatTimestamp(sessions[0].startTime))
log(ctx).Infof("Showing the latest log (%v)", formatTimestamp(sessions[0].startTime))
}

var data gather.WriteBuffer
Expand Down
2 changes: 1 addition & 1 deletion cli/command_policy_set_actions.go
Expand Up @@ -31,7 +31,7 @@ func (c *policyActionFlags) setup(cmd *kingpin.CmdClause) {
cmd.Flag("after-folder-action", "Path to after-folder action command ('none' to remove)").Default("-").PlaceHolder("COMMAND").StringVar(&c.policySetAfterFolderActionCommand)
cmd.Flag("before-snapshot-root-action", "Path to before-snapshot-root action command ('none' to remove or 'inherit')").Default("-").PlaceHolder("COMMAND").StringVar(&c.policySetBeforeSnapshotRootActionCommand)
cmd.Flag("after-snapshot-root-action", "Path to after-snapshot-root action command ('none' to remove or 'inherit')").Default("-").PlaceHolder("COMMAND").StringVar(&c.policySetAfterSnapshotRootActionCommand)
cmd.Flag("action-command-timeout", "Max time allowed for a action to run in seconds").Default("5m").DurationVar(&c.policySetActionCommandTimeout)
cmd.Flag("action-command-timeout", "Max time allowed for an action to run in seconds").Default("5m").DurationVar(&c.policySetActionCommandTimeout)
cmd.Flag("action-command-mode", "Action command mode").Default("essential").EnumVar(&c.policySetActionCommandMode, "essential", "optional", "async")
cmd.Flag("persist-action-script", "Persist action script").BoolVar(&c.policySetPersistActionScript)
}
Expand Down
2 changes: 1 addition & 1 deletion cli/command_policy_set_files.go
Expand Up @@ -39,7 +39,7 @@ func (c *policyFilesFlags) setup(cmd *kingpin.CmdClause) {
cmd.Flag("clear-dot-ignore", "Clear list of paths in the dot-ignore list").BoolVar(&c.policySetClearDotIgnore)
cmd.Flag("max-file-size", "Exclude files above given size").PlaceHolder("N").StringVar(&c.policySetMaxFileSize)

// Ignore other mounted fileystems.
// Ignore other mounted filesystems.
cmd.Flag("one-file-system", "Stay in parent filesystem when finding files ('true', 'false', 'inherit')").EnumVar(&c.policyOneFileSystem, booleanEnumValues...)

cmd.Flag("ignore-cache-dirs", "Ignore cache directories ('true', 'false', 'inherit')").EnumVar(&c.policyIgnoreCacheDirs, booleanEnumValues...)
Expand Down
2 changes: 1 addition & 1 deletion cli/command_repository_set_parameters.go
Expand Up @@ -35,7 +35,7 @@ func (c *commandRepositorySetParameters) setup(svc appServices, parent commandPa
cmd.Flag("max-pack-size-mb", "Set max pack file size").PlaceHolder("MB").IntVar(&c.maxPackSizeMB)
cmd.Flag("index-version", "Set version of index format used for writing").IntVar(&c.indexFormatVersion)

cmd.Flag("upgrade", "Uprade repository to the latest stable format").BoolVar(&c.upgradeRepositoryFormat)
cmd.Flag("upgrade", "Upgrade repository to the latest stable format").BoolVar(&c.upgradeRepositoryFormat)

cmd.Flag("epoch-refresh-frequency", "Epoch refresh frequency").DurationVar(&c.epochRefreshFrequency)
cmd.Flag("epoch-min-duration", "Minimal duration of a single epoch").DurationVar(&c.epochMinDuration)
Expand Down
2 changes: 1 addition & 1 deletion cli/command_repository_sync.go
Expand Up @@ -38,7 +38,7 @@ type commandRepositorySyncTo struct {
}

func (c *commandRepositorySyncTo) setup(svc advancedAppServices, parent commandParent) {
cmd := parent.Command("sync-to", "Synchronizes contents of this repository to another location")
cmd := parent.Command("sync-to", "Synchronizes the contents of this repository to another location")
cmd.Flag("update", "Whether to update blobs present in destination and source if the source is newer.").Default("true").BoolVar(&c.repositorySyncUpdate)
cmd.Flag("delete", "Whether to delete blobs present in destination but not source.").BoolVar(&c.repositorySyncDelete)
cmd.Flag("dry-run", "Do not perform copying.").Short('n').BoolVar(&c.repositorySyncDryRun)
Expand Down
2 changes: 1 addition & 1 deletion cli/command_show.go
Expand Up @@ -17,7 +17,7 @@ type commandShow struct {
}

func (c *commandShow) setup(svc appServices, parent commandParent) {
cmd := parent.Command("show", "Displays contents of a repository object.").Alias("cat")
cmd := parent.Command("show", "Displays the contents of a repository object.").Alias("cat")
cmd.Arg("object-path", "Path").Required().StringVar(&c.path)
cmd.Action(svc.repositoryReaderAction(c.run))

Expand Down
2 changes: 1 addition & 1 deletion cli/command_snapshot_list.go
Expand Up @@ -49,7 +49,7 @@ func (c *commandSnapshotList) setup(svc appServices, parent commandParent) {
cmd.Flag("mtime", "Include file mod time").BoolVar(&c.snapshotListShowModTime)
cmd.Flag("owner", "Include owner").BoolVar(&c.shapshotListShowOwner)
cmd.Flag("show-identical", "Show identical snapshots").Short('l').BoolVar(&c.snapshotListShowIdentical)
cmd.Flag("all", "Show all shapshots (not just current username/host)").Short('a').BoolVar(&c.snapshotListShowAll)
cmd.Flag("all", "Show all snapshots (not just current username/host)").Short('a').BoolVar(&c.snapshotListShowAll)
cmd.Flag("max-results", "Maximum number of entries per source.").Short('n').IntVar(&c.maxResultsPerPath)
cmd.Flag("tags", "Tag filters to apply on the list items. Must be provided in the <key>:<value> format.").StringsVar(&c.snapshotListTags)
c.jo.setup(svc, cmd)
Expand Down
2 changes: 1 addition & 1 deletion cli/storage_providers.go
Expand Up @@ -30,7 +30,7 @@ var storageProviders = []storageProvider{
{"b2", "a B2 bucket", func() storageFlags { return &storageB2Flags{} }},
{"filesystem", "a filesystem", func() storageFlags { return &storageFilesystemFlags{} }},
{"gcs", "a Google Cloud Storage bucket", func() storageFlags { return &storageGCSFlags{} }},
{"rclone", "an rclone-based provided", func() storageFlags { return &storageRcloneFlags{} }},
{"rclone", "a rclone-based provided", func() storageFlags { return &storageRcloneFlags{} }},
{"s3", "an S3 bucket", func() storageFlags { return &storageS3Flags{} }},
{"sftp", "an SFTP storage", func() storageFlags { return &storageSFTPFlags{} }},
{"webdav", "a WebDAV storage", func() storageFlags { return &storageWebDAVFlags{} }},
Expand Down
8 changes: 4 additions & 4 deletions cli/update_check.go
Expand Up @@ -128,7 +128,7 @@ func getLatestReleaseNameFromGitHub(ctx context.Context) (string, error) {
}

if err := json.NewDecoder(resp.Body).Decode(&responseObject); err != nil {
return "", errors.Wrap(err, "invalid Github API response")
return "", errors.Wrap(err, "invalid GitHub API response")
}

return responseObject.Name, nil
Expand Down Expand Up @@ -172,7 +172,7 @@ func (c *App) maybeCheckForUpdates(ctx context.Context) (string, error) {
}

if err := c.maybeCheckGithub(ctx, us); err != nil {
return "", errors.Wrap(err, "error checking github")
return "", errors.Wrap(err, "error checking GitHub")
}

log(ctx).Debugf("build version %v, available %v", ensureVPrefix(repo.BuildVersion), ensureVPrefix(us.AvailableVersion))
Expand Down Expand Up @@ -211,10 +211,10 @@ func (c *App) maybeCheckGithub(ctx context.Context, us *updateState) error {

newAvailableVersion, err := getLatestReleaseNameFromGitHub(ctx)
if err != nil {
return errors.Wrap(err, "update to get latest release from GitHub")
return errors.Wrap(err, "update to get the latest release from GitHub")
}

log(ctx).Debugf("latest version on github: %v previous %v", newAvailableVersion, us.AvailableVersion)
log(ctx).Debugf("latest version on GitHub: %v previous %v", newAvailableVersion, us.AvailableVersion)

// we got updated version from GitHub, write it in a state file again
if newAvailableVersion != us.AvailableVersion {
Expand Down
2 changes: 1 addition & 1 deletion repo/content/content_manager_lock_free.go
Expand Up @@ -85,7 +85,7 @@ func ValidatePrefix(prefix ID) error {
}
}

return errors.Errorf("invalid prefix, must be a empty or single letter between 'g' and 'z'")
return errors.Errorf("invalid prefix, must be empty or a single letter between 'g' and 'z'")
}

func (bm *WriteManager) getContentDataReadLocked(ctx context.Context, pp *pendingPackInfo, bi Info, output *gather.WriteBuffer) error {
Expand Down
2 changes: 1 addition & 1 deletion repo/content/content_manager_test.go
Expand Up @@ -2158,7 +2158,7 @@ func verifyDeletedContentRead(ctx context.Context, t *testing.T, bm *WriteManage
}

if !ci.GetDeleted() {
t.Errorf("Expected content to be deleted but it is not: %#v", ci)
t.Errorf("Expected content to be deleted, but it is not: %#v", ci)
}
}

Expand Down
4 changes: 2 additions & 2 deletions site/content/_index.html
Expand Up @@ -18,7 +18,7 @@
User Support Forum<i class="fas fa-comments ml-2"></i>
</a>
<a class="btn btn-lg btn-success mr-3 mb-4" href="https://slack.kopia.io">
Developer Discusson <i class="fab fa-slack ml-2 "></i>
Developer Discussion <i class="fab fa-slack ml-2 "></i>
</a>
<p class="font-weight-bold h3 mt-5">Encrypted, Deduplicated, and Compressed Data Backups Using Your Own Cloud Storage</p>
</div>
Expand All @@ -39,7 +39,7 @@ <h2 class="text-center pb-3">Kopia Demo</h2>
<div class="col text-center">
<h2 class="text-center pb-3">KopiaUI</h2>

<p>Kopia comes with a user friendly desktop app for Windows, macOS and Linux which allows you to create snapshots, define policies and restore files quickly.</p>
<p>Kopia comes with a user-friendly desktop app for Windows, macOS and Linux which allows you to create snapshots, define policies and restore files quickly.</p>

<iframe width="560" height="315" src="https://www.youtube.com/embed/sHJjSpasWIo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Expand Down
12 changes: 6 additions & 6 deletions site/content/docs/Advanced/Actions/_index.md
Expand Up @@ -36,13 +36,13 @@ $ kopia policy set /some/dir --before-snapshot-root-action /path/to/command
$ kopia policy set /some/dir --after-snapshot-root-action /path/to/command
```

>NOTE: Unlike all other policy options, `--before-folder-action` and `--after-folder-action` are not inherited and must be set explicitly on target folders, while `--before-snapshot-root-action` and `--after-snapshot-root-action` are interited from their parents and can be set at global, host, user or directory level.
>NOTE: Unlike all other policy options, `--before-folder-action` and `--after-folder-action` are not inherited and must be set explicitly on target folders, while `--before-snapshot-root-action` and `--after-snapshot-root-action` are inherited from their parents and can be set at global, host, user or directory level.
Actions can be `essential` (must succeed, default behavior), `optional` (failures are tolerated) or `async` (kopia will start the action but not wait for it to finish). This can be set
using `--action-command-mode`, for example:

```
$ kopia policy set /some/dir --mode=async \
$ kopia policy set /some/dir --action-command-mode=async \
--before-folder-action /usr/local/bin/notifier.sh
```

Expand All @@ -55,10 +55,10 @@ $ kopia policy set /some/dir --action-command-timeout=180s \

Finally, the action command itself can be stored in a repository, when `--persist-action-script` is passed. To prevent binaries from being stored, the maximum script length can be up to 32000 characters.

Scripts stored like this will be temporarily extracted to a local directory and executed using shell command, which is:
Scripts stored like this will be temporarily extracted to a local directory and executed using a shell command, which is:

* On Linux and macOS: `sh -e /path/to/temporary/script/file.sh"
* On Windows: "cmd.exe /c C:\path\to\temporary\script\file.cmd"
* On Linux and macOS: `sh -e /path/to/temporary/script/file.sh`
* On Windows: `cmd.exe /c C:\path\to\temporary\script\file.cmd`

On Unix, if the script has `#!` prefix, it will be executed directly, bypassing the `/bin/sh` shell.

Expand Down Expand Up @@ -131,7 +131,7 @@ Those are just some initial ideas, we're certain more interesting types of actio

If you have ideas for extending this mechanism, definitely [file an Issue on Github](https://github.com/kopia/kopia/issues).

If you develop a useful action script that you'd like to share with the communnity, we encourage you
If you develop a useful action script that you'd like to share with the community, we encourage you
to do so by sending us a pull request to add to this web page or you can put them in your own repository and we'll be happy to link it from here.

To get started, click 'Edit This Page' link.
2 changes: 1 addition & 1 deletion site/content/docs/Advanced/Architecture/_index.md
Expand Up @@ -69,7 +69,7 @@ The API for CAOS can be found in https://godoc.org/github.com/kopia/kopia/repo/o

### Label-Addressable Manifest Storage (LAMS)

While content-addressable storage is a neat idea, dealing with cryptographic hashes its not very convenient for humans to use.
While content-addressable storage is a neat idea, dealing with cryptographic hashes is not very convenient for humans to use.

To address that, Kopia supports another type of storage, used to persist small JSON objects called **Manifests** (describing snapshots, policies, etc.) which are identified by arbitrary `key=value` pairs called labels.

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/Advanced/Caching/_index.md
Expand Up @@ -17,9 +17,9 @@ Default Cache Directory Location varies by operating system:
Where `{unique-id}` is a hash of configuration file used and unique identifier that's specific to a
connected repository.

The cache directory location can be overridden when connecting to a repository by specifying `--cache-directory` flag or `KOPIA_CACHE_DIRECTORY` environment variable. It will be persited in the configuration file.
The cache directory location can be overridden when connecting to a repository by specifying `--cache-directory` flag or `KOPIA_CACHE_DIRECTORY` environment variable. It will be persisted in the configuration file.

When set `KOPIA_CACHE_DIRECTORY` environment variable takes precendence over location stored in the configuration file.
When set `KOPIA_CACHE_DIRECTORY` environment variable takes precedence over location stored in the configuration file.

### Cache Types

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/Advanced/Compatibility/_index.md
Expand Up @@ -16,7 +16,7 @@ In order to ensure that snapshots created with Kopia will be available as the pr

- for releases with major version >= `v2` (i.e. `vx.y.z`), *previous version* means previous *major* version (`v(x-1)`).

2. While not explicitly guaranteed, it is possible and likely that Kopia will be able to read (but not necessarily write) snapshots created with even older versions of software than explicitly guaranteed. For example it's likely that Kopia `v0.6.0` will read snapshots created using `v0.3.0`, even though it's three releases behind.
2. While not explicitly guaranteed, it is possible and likely that Kopia will be able to read (but not necessarily write) snapshots created with even older versions of software than explicitly guaranteed. For example, it's likely that Kopia `v0.6.0` will read snapshots created using `v0.3.0`, even though it's three releases behind.

3. In order to avoid corrupting data, Kopia will refuse to mutate repositories it's not designed to safely handle. That means, it will typically only allow reading, but not writing older versions of repository, unless explicitly documented and tested.

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/Advanced/Logging/_index.md
Expand Up @@ -50,5 +50,5 @@ You can control how much data is written to console and log files by using flags

### Color Output

By default console output will be colored to indicate different log levels, this can be disabled (useful when redirecting output to a file) with `--disable-color`. To force color colorized output when redirecting to a file use `--force-color`.
By default, console output will be colored to indicate different log levels, this can be disabled (useful when redirecting output to a file) with `--disable-color`. To force color colorized output when redirecting to a file use `--force-color`.

2 changes: 1 addition & 1 deletion site/content/docs/Advanced/Maintenance/_index.md
Expand Up @@ -79,7 +79,7 @@ The current user must be the maintenance owner.

## Maintenance Safety

Kopia's maintenance routine follows certain safety rules which rely on passage of time to ensure correctness. This is needed in case other Kopia clients are currently operating on the repository. To guarantee correctness, certain length of time must pass to ensure all caches and transient state are properly synchronized with the repository. Kopia must also also account for eventual consistency delays intoduced by the blob storage provider.
Kopia's maintenance routine follows certain safety rules which rely on passage of time to ensure correctness. This is needed in case other Kopia clients are currently operating on the repository. To guarantee correctness, certain length of time must pass to ensure all caches and transient state are properly synchronized with the repository. Kopia must also account for eventual consistency delays introduced by the blob storage provider.

This means that effects of full maintenance are not immediate - it may take several hours and/or multiple maintenance cycles to remove blobs that are not in use.

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/Advanced/Synchronization/_index.md
Expand Up @@ -17,13 +17,13 @@ $ kopia repository sync-to gcs --bucket my-bucket

The calling user must have read access to current repository and read/write access to the destination.

By default synchronization does not perform any deletions in the destination location, even if the source file has been deleted. Without deletions, the resulting repository will still be correct, but will not benefit from compaction and will run more slowly. To allow deletions, pass `--delete` option:
By default, synchronization does not perform any deletions in the destination location, even if the source file has been deleted. Without deletions, the resulting repository will still be correct, but will not benefit from compaction and will run more slowly. To allow deletions, pass `--delete` option:

```
$ kopia repository sync-to filesystem --path /dest/repository --delete
```

When synchronizing to a filesystem location, it is important to check that the filesystem is mounted correctly. To ensure that Kopia will not unneccessarily download potentially large repositories when destination filesystem is accidentally unmounted, pass `--must-exist`:
When synchronizing to a filesystem location, it is important to check that the filesystem is mounted correctly. To ensure that Kopia will not unnecessarily download potentially large repositories when destination filesystem is accidentally unmounted, pass `--must-exist`:

```
$ kopia repository sync-to filesystem --path /dest/repository --must-exist
Expand Down

0 comments on commit d9c1bd0

Please sign in to comment.