Skip to content

Commit 88e9395

Browse files
committed
docs, completion: use symlinks instead of symbol(ic) links
Symbolic links is the official term, but more commonly we refer to them as symlinkx. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent f550901 commit 88e9395

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

cli/command/container/cp.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ container source to stdout.`,
158158
}
159159

160160
flags := cmd.Flags()
161-
flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symbol link in SRC_PATH")
161+
flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symlinks in SRC_PATH")
162162
flags.BoolVarP(&opts.copyUIDGID, "archive", "a", false, "Archive mode (copy all uid/gid information)")
163163
flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached")
164164
return cmd
@@ -271,7 +271,7 @@ func copyFromContainer(ctx context.Context, dockerCLI command.Cli, copyConfig cp
271271
}
272272

273273
apiClient := dockerCLI.Client()
274-
// if client requests to follow symbol link, then must decide target file to be copied
274+
// if client requests to follow symlinks, then must decide target file to be copied
275275
var rebaseName string
276276
if copyConfig.followLink {
277277
src, err := apiClient.ContainerStatPath(ctx, copyConfig.container, client.ContainerStatPathOptions{

contrib/completion/fish/docker.fish

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -a '(__fish_pri
170170
# cp
171171
complete -c docker -f -n '__fish_docker_no_subcommand' -a cp -d "Copy files/folders between a container and the local filesystem"
172172
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s a -l archive -d 'Archive mode (copy all uid/gid information)'
173-
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s L -l follow-link -d 'Always follow symbol link in SRC_PATH'
173+
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -s L -l follow-link -d 'Always follow symlinks in SRC_PATH'
174174
complete -c docker -A -f -n '__fish_seen_subcommand_from cp' -l help -d 'Print usage'
175175

176176
# create

contrib/completion/zsh/_docker

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -706,7 +706,7 @@ __docker_container_subcommand() {
706706
local state
707707
_arguments $(__docker_arguments) \
708708
$opts_help \
709-
"($help -L --follow-link)"{-L,--follow-link}"[Always follow symbol link]" \
709+
"($help -L --follow-link)"{-L,--follow-link}"[Always follow symlinks]" \
710710
"($help -)1:container:->container" \
711711
"($help -)2:hostpath:_files" && ret=0
712712
case $state in

docs/reference/commandline/container_cp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ container source to stdout.
1717
| Name | Type | Default | Description |
1818
|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------|
1919
| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) |
20-
| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH |
20+
| `-L`, `--follow-link` | `bool` | | Always follow symlinks in SRC_PATH |
2121
| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
2222

2323

docs/reference/commandline/cp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ container source to stdout.
1717
| Name | Type | Default | Description |
1818
|:----------------------|:-------|:--------|:-------------------------------------------------------------------------------------------------------------|
1919
| `-a`, `--archive` | `bool` | | Archive mode (copy all uid/gid information) |
20-
| `-L`, `--follow-link` | `bool` | | Always follow symbol link in SRC_PATH |
20+
| `-L`, `--follow-link` | `bool` | | Always follow symlinks in SRC_PATH |
2121
| `-q`, `--quiet` | `bool` | | Suppress progress output during copy. Progress output is automatically suppressed if no terminal is attached |
2222

2323

0 commit comments

Comments
 (0)