Removed all mentions of "please" from docs and messages

Signed-off-by: Grace Choi <gracechoi@utexas.edu>
Signed-off-by: Pranjal Rai <pranjalrai@utexas.edu>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Grace Choi 2024-04-26 13:16:51 -05:00 committed by Sebastiaan van Stijn
parent 0022fe7111
commit e06ef800fc
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
42 changed files with 58 additions and 57 deletions

View File

@ -8,12 +8,12 @@ body:
attributes:
value: |
Thank you for taking the time to report a bug!
If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com).
If this is a security issue report it to the [Docker Security team](mailto:security@docker.com).
- type: textarea
id: description
attributes:
label: Description
description: Please give a clear and concise description of the bug
description: Give a clear and concise description of the bug
validations:
required: true
- type: textarea

View File

@ -4,7 +4,7 @@ contact_links:
about: "Read guidelines and tips about contributing to Docker."
url: "https://github.com/docker/cli/blob/master/CONTRIBUTING.md"
- name: "Security and Vulnerabilities"
about: "Please report any security issues or vulnerabilities responsibly to the Docker security team. Please do not use the public issue tracker."
about: "Report any security issues or vulnerabilities responsibly to the Docker security team. Do not use the public issue tracker."
url: "https://github.com/moby/moby/security/policy"
- name: "General Support"
about: "Get the help you need to build, share, and run your Docker applications"

View File

@ -1,5 +1,5 @@
<!--
Please make sure you've read and understood our contributing guidelines;
Make sure you've read and understood our contributing guidelines;
https://github.com/docker/cli/blob/master/CONTRIBUTING.md
** Make sure all your commits include a signature generated with `git commit -s` **
@ -10,7 +10,7 @@ guide https://docs.docker.com/opensource/code/
If this is a bug fix, make sure your description includes "fixes #xxxx", or
"closes #xxxx"
Please provide the following information:
Provide the following information:
-->
**- What I did**

View File

@ -32,7 +32,7 @@ jobs:
desc=$(echo "$block" | awk NF)
if [ -z "$desc" ]; then
echo "::error::Changelog section is empty. Please provide a description for the changelog."
echo "::error::Changelog section is empty. Provide a description for the changelog."
exit 1
fi

2
.gitignore vendored
View File

@ -1,5 +1,5 @@
# if you want to ignore files created by your editor/tools,
# please consider a global .gitignore https://help.github.com/articles/ignoring-files
# consider a global .gitignore https://help.github.com/articles/ignoring-files
*.exe
*.exe~
*.orig

View File

@ -16,9 +16,9 @@ start participating.
## Reporting security issues
The Docker maintainers take security seriously. If you discover a security
issue, please bring it to their attention right away!
issue, bring it to their attention right away!
Please **DO NOT** file a public issue, instead send your report privately to
**DO NOT** file a public issue, instead send your report privately to
[security@docker.com](mailto:security@docker.com).
Security reports are greatly appreciated and we will publicly thank you for it.
@ -39,7 +39,7 @@ If you find a match, you can use the "subscribe" button to get notified on
updates. Do *not* leave random "+1" or "I have this too" comments, as they
only clutter the discussion, and don't help resolving it. However, if you
have ways to reproduce the issue or have additional information that may help
resolving the issue, please leave a comment.
resolving the issue, leave a comment.
When reporting issues, always include:
@ -166,10 +166,10 @@ Include an issue reference like `Closes #XXXX` or `Fixes #XXXX` in the pull requ
description that close an issue. Including references automatically closes the issue
on a merge.
Please do not add yourself to the `AUTHORS` file, as it is regenerated regularly
Do not add yourself to the `AUTHORS` file, as it is regenerated regularly
from the Git history.
Please see the [Coding Style](#coding-style) for further guidelines.
See the [Coding Style](#coding-style) for further guidelines.
### Merge approval
@ -269,8 +269,8 @@ guidelines for the community as a whole:
* Stay on topic: Make sure that you are posting to the correct channel and
avoid off-topic discussions. Remember when you update an issue or respond
to an email you are potentially sending to a large number of people. Please
consider this before you update. Also remember that nobody likes spam.
to an email you are potentially sending to a large number of people. Consider
this before you update. Also remember that nobody likes spam.
* Don't send email to the maintainers: There's no need to send email to the
maintainers to ask them to investigate an issue or to take a look at a

2
NOTICE
View File

@ -14,6 +14,6 @@ United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not
violate applicable laws.
For more information, please see https://www.bis.doc.gov
For more information, see https://www.bis.doc.gov
See also https://www.apache.org/dev/crypto.html and/or seek legal counsel.

View File

@ -67,7 +67,7 @@ make -f docker.Makefile shell
## Legal
*Brought to you courtesy of our legal counsel. For more context,
please see the [NOTICE](https://github.com/docker/cli/blob/master/NOTICE) document in this repo.*
see the [NOTICE](https://github.com/docker/cli/blob/master/NOTICE) document in this repo.*
Use and transfer of Docker may be subject to certain restrictions by the
United States and other governments.
@ -75,7 +75,7 @@ United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not
violate applicable laws.
For more information, please see https://www.bis.doc.gov
For more information, see https://www.bis.doc.gov
## Licensing

View File

@ -54,7 +54,7 @@ func setupCommonRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *c
rootCmd.SetHelpCommand(helpCommand)
rootCmd.PersistentFlags().BoolP("help", "h", false, "Print usage")
rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help")
rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "use --help")
rootCmd.PersistentFlags().Lookup("help").Hidden = true
rootCmd.Annotations = map[string]string{

View File

@ -546,7 +546,7 @@ func getServerHost(hosts []string, tlsOptions *tlsconfig.Options) (string, error
case 1:
host = hosts[0]
default:
return "", errors.New("Please specify only one -H")
return "", errors.New("Specify only one -H")
}
return dopts.ParseHost(tlsOptions != nil, host)

View File

@ -42,7 +42,7 @@ func writeTo(dockerCli command.Cli, reader io.Reader, dest string) error {
var printDest bool
if dest == "-" {
if dockerCli.Out().IsTerminal() {
return errors.New("cowardly refusing to export to a terminal, please specify a file path")
return errors.New("cowardly refusing to export to a terminal, specify a file path")
}
writer = dockerCli.Out()
} else {

View File

@ -100,7 +100,7 @@ func PushTrustedReference(ioStreams command.Streams, repoInfo *registry.Reposito
}
if target == nil {
return errors.Errorf("no targets found, please provide a specific tag in order to sign it")
return errors.Errorf("no targets found, provide a specific tag in order to sign it")
}
fmt.Fprintln(ioStreams.Out(), "Signing and pushing trust metadata")

View File

@ -29,7 +29,7 @@ const patSuggest = "You can log in with your password or a Personal Access " +
// for the given command.
func RegistryAuthenticationPrivilegedFunc(cli Cli, index *registrytypes.IndexInfo, cmdName string) types.RequestPrivilegeFunc {
return func(ctx context.Context) (string, error) {
fmt.Fprintf(cli.Out(), "\nPlease login prior to %s:\n", cmdName)
fmt.Fprintf(cli.Out(), "\nLogin prior to %s:\n", cmdName)
indexServer := registry.GetAuthConfigKey(index)
isDefaultRegistry := indexServer == registry.IndexServer
authConfig, err := GetDefaultAuthConfig(cli.ConfigFile(), true, indexServer, isDefaultRegistry)

View File

@ -14,7 +14,7 @@ func TestConfigWithEmptyComposeFile(t *testing.T) {
cmd := newConfigCommand(test.NewFakeCli(&fakeClient{}))
cmd.SetOut(io.Discard)
assert.ErrorContains(t, cmd.Execute(), `Please specify a Compose file`)
assert.ErrorContains(t, cmd.Execute(), `Specify a Compose file`)
}
func TestConfigMergeInterpolation(t *testing.T) {

View File

@ -76,7 +76,7 @@ func GetConfigDetails(composefiles []string, stdin io.Reader) (composetypes.Conf
var details composetypes.ConfigDetails
if len(composefiles) == 0 {
return details, errors.New("Please specify a Compose file (with --compose-file)")
return details, errors.New("Specify a Compose file (with --compose-file)")
}
if composefiles[0] == "-" && len(composefiles) == 1 {

View File

@ -7,5 +7,5 @@ command and provide the following key:
unlock-key
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.

View File

@ -5,5 +5,5 @@ command and provide the following key:
unlock-key
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.

View File

@ -3,5 +3,5 @@ command and provide the following key:
unlock-key
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.

View File

@ -4,5 +4,5 @@ command and provide the following key:
unlock-key
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.

View File

@ -54,7 +54,7 @@ func runUnlock(ctx context.Context, dockerCli command.Cli) error {
return errors.New("Error: swarm is not locked")
}
key, err := readKey(dockerCli.In(), "Please enter unlock key: ")
key, err := readKey(dockerCli.In(), "Enter unlock key: ")
if err != nil {
return err
}

View File

@ -88,7 +88,7 @@ func printUnlockCommand(out io.Writer, unlockKey string) {
if len(unlockKey) > 0 {
fmt.Fprintf(out, "To unlock a swarm manager after it restarts, "+
"run the `docker swarm unlock`\ncommand and provide the following key:\n\n %s\n\n"+
"Please remember to store this key in a password manager, since without it you\n"+
"Remember to store this key in a password manager, since without it you\n"+
"will not be able to restart the manager.\n", unlockKey)
}
}

View File

@ -44,7 +44,7 @@ func revokeTrust(ctx context.Context, dockerCLI command.Cli, remote string, opti
return errors.New("cannot use a digest reference for IMAGE:TAG")
}
if imgRefAndAuth.Tag() == "" && !options.forceYes {
deleteRemote, err := command.PromptForConfirmation(ctx, dockerCLI.In(), dockerCLI.Out(), fmt.Sprintf("Please confirm you would like to delete all signature data for %s?", remote))
deleteRemote, err := command.PromptForConfirmation(ctx, dockerCLI.In(), dockerCLI.Out(), fmt.Sprintf("Confirm you would like to delete all signature data for %s?", remote))
if err != nil {
return err
}

View File

@ -70,7 +70,7 @@ func TestTrustRevokeCommand(t *testing.T) {
doc: "OfflineErrors_Confirm",
notaryRepository: notary.GetOfflineNotaryRepository,
args: []string{"reg-name.io/image"},
expectedMessage: "Please confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedMessage: "Confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedErr: revokeCancelledError,
},
{
@ -89,7 +89,7 @@ func TestTrustRevokeCommand(t *testing.T) {
doc: "UninitializedErrors_Confirm",
notaryRepository: notary.GetUninitializedNotaryRepository,
args: []string{"reg-name.io/image"},
expectedMessage: "Please confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedMessage: "Confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedErr: revokeCancelledError,
},
{
@ -108,7 +108,7 @@ func TestTrustRevokeCommand(t *testing.T) {
doc: "EmptyNotaryRepo_Confirm",
notaryRepository: notary.GetEmptyTargetsNotaryRepository,
args: []string{"reg-name.io/image"},
expectedMessage: "Please confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedMessage: "Confirm you would like to delete all signature data for reg-name.io/image? [y/N] ",
expectedErr: revokeCancelledError,
},
{
@ -127,7 +127,7 @@ func TestTrustRevokeCommand(t *testing.T) {
doc: "AllSigConfirmation",
notaryRepository: notary.GetEmptyTargetsNotaryRepository,
args: []string{"alpine"},
expectedMessage: "Please confirm you would like to delete all signature data for alpine? [y/N] ",
expectedMessage: "Confirm you would like to delete all signature data for alpine? [y/N] ",
expectedErr: revokeCancelledError,
},
}

View File

@ -53,7 +53,7 @@ func addSigner(ctx context.Context, dockerCLI command.Cli, options signerAddOpti
return fmt.Errorf("signer name \"%s\" must start with lowercase alphanumeric characters and can include \"-\" or \"_\" after the first character", signerName)
}
if signerName == "releases" {
return errors.New("releases is a reserved keyword, please use a different signer name")
return errors.New("releases is a reserved keyword, use a different signer name")
}
if options.keys.Len() == 0 {

View File

@ -34,7 +34,7 @@ func TestTrustSignerAddErrors(t *testing.T) {
{
name: "reserved-releases-signer-add",
args: []string{"releases", "my-image", "--key", "/path/to/key"},
expectedError: "releases is a reserved keyword, please use a different signer name",
expectedError: "releases is a reserved keyword, use a different signer name",
},
{
name: "disallowed-chars",

View File

@ -1 +1 @@
Please confirm you would like to delete all signature data for example/trust-demo? [y/N]
Confirm you would like to delete all signature data for example/trust-demo? [y/N]

View File

@ -149,7 +149,7 @@ func (c *commandConn) handleEOF(err error) error {
c.stderrMu.Lock()
stderr := c.stderr.String()
c.stderrMu.Unlock()
return errors.Errorf("command %v has exited with %v, please make sure the URL is valid, and Docker 18.09 or later is installed on the remote host: stderr=%s", c.cmd.Args, werr, stderr)
return errors.Errorf("command %v has exited with %v, make sure the URL is valid, and Docker 18.09 or later is installed on the remote host: stderr=%s", c.cmd.Args, werr, stderr)
}
func ignorableCloseError(err error) bool {

View File

@ -63,7 +63,7 @@
# must have access to the socket for the completions to function correctly
#
# Note for developers:
# Please arrange options sorted alphabetically by long name with the short
# Arrange options sorted alphabetically by long name with the short
# options immediately following their corresponding long form.
# This order should be applied to lists, alternatives and code blocks.

View File

@ -18,7 +18,7 @@ git add -A
cp -rf /out/* .
diff=$(git status --porcelain -- AUTHORS)
if [ -n "$diff" ]; then
echo >&2 'ERROR: Authors result differs. Please update with "make -f docker.Makefile authors"'
echo >&2 'ERROR: Authors result differs. Update with "make -f docker.Makefile authors"'
echo "$diff"
exit 1
fi

View File

@ -209,7 +209,8 @@ CLI to use API version 1.23, which produces an error:
```console
DOCKER_API_VERSION=1.23 docker version
Error response from daemon: client version 1.23 is too old. Minimum supported API version is 1.24, please upgrade your client to a newer version
Error response from daemon: client version 1.23 is too old. Minimum supported API version is 1.24,
upgrade your client to a newer version
```
An environment variable (`DOCKER_MIN_API_VERSION`) is introduced that allows
@ -611,7 +612,7 @@ The `--log-opt fluentd-async-connect` option for the fluentd logging driver is
A deprecation message is logged in the daemon logs if the old option is used:
```console
fluent#New: AsyncConnect is now deprecated, please use Async instead
fluent#New: AsyncConnect is now deprecated, use Async instead
```
Users are encouraged to use the `fluentd-async` option going forward, as support

View File

@ -122,7 +122,7 @@ We have to put the following JSON to `$TMPDIR/config.json`:
}
```
Please note a couple of points:
Note a couple of points:
- `PropagatedMount` is needed so that the docker daemon can see mounts done by the
rexray plugin from within the container, otherwise the docker daemon is not able
to mount a docker volume.

View File

@ -103,7 +103,7 @@ Copy files from container to local path
$ docker cp CONTAINER:/var/logs/ /tmp/app_logs
```
Copy a file from container to stdout. Please note `cp` command produces a tar stream
Copy a file from container to stdout. Note `cp` command produces a tar stream
```console
$ docker cp CONTAINER:/var/logs/app.log - | tar x -O | grep "ERROR"

View File

@ -39,7 +39,7 @@ command and provide the following key:
SWMKEY-1-fySn8TY4w5lKcWcJPIpKufejh9hxx5KYwx6XZigx3Q4
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.
```
@ -56,7 +56,7 @@ command and provide the following key:
SWMKEY-1-7c37Cc8654o6p38HnroywCi19pllOnGtbdZEgtKxZu8
Please remember to store this key in a password manager, since without it you
Remember to store this key in a password manager, since without it you
will not be able to restart the manager.
```

View File

@ -24,7 +24,7 @@ enabled, and is also available from the `docker swarm unlock-key` command.
```console
$ docker swarm unlock
Please enter unlock key:
Enter unlock key:
```
## Related commands

View File

@ -91,7 +91,7 @@ When `alice`, one of the signers, runs `docker trust revoke`:
```console
$ docker trust revoke example/trust-demo
Please confirm you would like to delete all signature data for example/trust-demo? [y/N] y
Confirm you would like to delete all signature data for example/trust-demo? [y/N] y
Enter passphrase for delegation key with ID 27d42a8:
Successfully deleted signature for example/trust-demo
```

View File

@ -93,7 +93,7 @@ func TestGlobalArgsOnlyParsedOnce(t *testing.T) {
args: []string{"-H", dh, "-H", dh, "version", "-f", "{{.Client.Version}}"},
expectedExitCode: 1,
expectedOut: icmd.None,
expectedErr: "Please specify only one -H",
expectedErr: "Specify only one -H",
},
{
name: "builtin",

View File

@ -9,7 +9,7 @@ import (
"gotest.tools/v3/icmd"
)
const shortHFlagDeprecated = "Flag shorthand -h has been deprecated, please use --help\n"
const shortHFlagDeprecated = "Flag shorthand -h has been deprecated, use --help\n"
// TestRunNonexisting ensures correct behaviour when running a nonexistent plugin.
func TestRunNonexisting(t *testing.T) {

View File

@ -7,7 +7,7 @@ provided for test and evaluation in your sandbox environments.
The information below describes each feature and the GitHub pull requests and
issues associated with it. If necessary, links are provided to additional
documentation on an issue. As an active Docker user and community member,
please feel free to provide any feedback on these features you wish.
feel free to provide any feedback on these features you wish.
## Use Docker experimental

View File

@ -60,7 +60,7 @@ unix://[/path/to/socket] to use.
Use "docker help" or "docker --help" to get an overview of available commands.
# EXAMPLES
For specific client examples please see the man page for the specific Docker
For specific client examples see the man page for the specific Docker
command. For example:
man docker-run

View File

@ -286,7 +286,7 @@ unix://[/path/to/socket] to use.
This setting will also enable IPv6 forwarding if you have both
**--ip-forward=true** and **--fixed-cidr-v6** set. Note that this may reject
Router Advertisements and interfere with the host's existing IPv6
configuration. For more information, please consult the documentation about
configuration. For more information, consult the documentation about
"Advanced Networking - IPv6".
**--ip-masq**=**true**|**false**
@ -301,7 +301,7 @@ unix://[/path/to/socket] to use.
containers. Use together with **--fixed-cidr-v6** to provide globally routable
IPv6 addresses. IPv6 forwarding will be enabled if not used with
**--ip-forward=false**. This may collide with your host's current IPv6
settings. For more information please consult the documentation about
settings. For more information consult the documentation about
"Advanced Networking - IPv6".
**--isolation**="*default*"

View File

@ -85,7 +85,7 @@ details of the format.
Type=container Status=destroy ID=2ee349dac409e97974ce8d01b70d250b85e0ba8189299c126a87812311951e26
If a format is set to `{{json .}}`, the events are streamed as valid JSON
Lines. For information about JSON Lines, please refer to https://jsonlines.org .
Lines. For information about JSON Lines, refer to https://jsonlines.org .
# docker events --format '{{json .}}'
{"status":"create","id":"196016a57679bf42424484918746a9474cd905dd993c4d0f4..

View File

@ -29,7 +29,7 @@ update() {
validate() {
diff=$(git status --porcelain -- vendor.mod vendor.sum vendor)
if [ -n "$diff" ]; then
echo >&2 'ERROR: Vendor result differs. Please vendor your package with "make -f docker.Makefile vendor"'
echo >&2 'ERROR: Vendor result differs. Vendor your package with "make -f docker.Makefile vendor"'
echo "$diff"
exit 1
fi