diff --git a/src/doc/man/cargo-publish.md b/src/doc/man/cargo-publish.md index 4e4d3b70ebf..c5e64db80de 100644 --- a/src/doc/man/cargo-publish.md +++ b/src/doc/man/cargo-publish.md @@ -22,8 +22,11 @@ following steps: - Checks the `package.publish` key in the manifest for restrictions on which registries you are allowed to publish to. 2. Create a `.crate` file by following the steps in {{man "cargo-package" 1}}. -3. Upload the crate to the registry. Note that the server will perform - additional checks on the crate. +3. Upload the crate to the registry. The server will perform additional + checks on the crate. +4. The client will poll waiting for the package to appear in the index, + and may timeout. In that case, you will need to check for completion + manually. This timeout does not affect the upload. This command requires you to be authenticated with either the `--token` option or using {{man "cargo-login" 1}}. diff --git a/src/doc/man/generated_txt/cargo-publish.txt b/src/doc/man/generated_txt/cargo-publish.txt index 2918da3e21f..ab1337d3c63 100644 --- a/src/doc/man/generated_txt/cargo-publish.txt +++ b/src/doc/man/generated_txt/cargo-publish.txt @@ -18,8 +18,12 @@ DESCRIPTION 2. Create a .crate file by following the steps in cargo-package(1). - 3. Upload the crate to the registry. Note that the server will perform - additional checks on the crate. + 3. Upload the crate to the registry. The server will perform additional + checks on the crate. + + 4. The client will poll waiting for the package to appear in the index, + and may timeout. In that case, you will need to check for completion + manually. This timeout does not affect the upload. This command requires you to be authenticated with either the --token option or using cargo-login(1). diff --git a/src/doc/src/commands/cargo-publish.md b/src/doc/src/commands/cargo-publish.md index ab364b9ed7c..bc84e61c08a 100644 --- a/src/doc/src/commands/cargo-publish.md +++ b/src/doc/src/commands/cargo-publish.md @@ -19,8 +19,11 @@ following steps: - Checks the `package.publish` key in the manifest for restrictions on which registries you are allowed to publish to. 2. Create a `.crate` file by following the steps in [cargo-package(1)](cargo-package.html). -3. Upload the crate to the registry. Note that the server will perform - additional checks on the crate. +3. Upload the crate to the registry. The server will perform additional + checks on the crate. +4. The client will poll waiting for the package to appear in the index, + and may timeout. In that case, you will need to check for completion + manually. This timeout does not affect the upload. This command requires you to be authenticated with either the `--token` option or using [cargo-login(1)](cargo-login.html). diff --git a/src/etc/man/cargo-publish.1 b/src/etc/man/cargo-publish.1 index 1f36abaa2e7..b2d95b9fd87 100644 --- a/src/etc/man/cargo-publish.1 +++ b/src/etc/man/cargo-publish.1 @@ -27,8 +27,14 @@ which registries you are allowed to publish to. .RE .sp .RS 4 -\h'-04' 3.\h'+01'Upload the crate to the registry. Note that the server will perform -additional checks on the crate. +\h'-04' 3.\h'+01'Upload the crate to the registry. The server will perform additional +checks on the crate. +.RE +.sp +.RS 4 +\h'-04' 4.\h'+01'The client will poll waiting for the package to appear in the index, +and may timeout. In that case, you will need to check for completion +manually. This timeout does not affect the upload. .RE .sp This command requires you to be authenticated with either the \fB\-\-token\fR option