Skip to content

Commit

Permalink
Auto merge of #12733 - tompscanlan:11616-document-timeout-behavior, r…
Browse files Browse the repository at this point in the history
…=epage

docs: warn about upload timeout

### What does this PR try to resolve?

Adds documentation missing from #11062 as noticed in #11616

### How should we test and review this PR?

editor review
  • Loading branch information
bors committed Sep 25, 2023
2 parents 739624f + 9839454 commit c1c2e7b
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
7 changes: 5 additions & 2 deletions src/doc/man/cargo-publish.md
Expand Up @@ -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}}.
Expand Down
8 changes: 6 additions & 2 deletions src/doc/man/generated_txt/cargo-publish.txt
Expand Up @@ -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).
Expand Down
7 changes: 5 additions & 2 deletions src/doc/src/commands/cargo-publish.md
Expand Up @@ -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).
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-publish.1
Expand Up @@ -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
Expand Down

0 comments on commit c1c2e7b

Please sign in to comment.