Skip to content

Commit c1c2e7b

Browse files
committed
Auto merge of #12733 - tompscanlan:11616-document-timeout-behavior, r=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
2 parents 739624f + 9839454 commit c1c2e7b

File tree

4 files changed

+24
-8
lines changed

4 files changed

+24
-8
lines changed

src/doc/man/cargo-publish.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,11 @@ following steps:
2222
- Checks the `package.publish` key in the manifest for restrictions on
2323
which registries you are allowed to publish to.
2424
2. Create a `.crate` file by following the steps in {{man "cargo-package" 1}}.
25-
3. Upload the crate to the registry. Note that the server will perform
26-
additional checks on the crate.
25+
3. Upload the crate to the registry. The server will perform additional
26+
checks on the crate.
27+
4. The client will poll waiting for the package to appear in the index,
28+
and may timeout. In that case, you will need to check for completion
29+
manually. This timeout does not affect the upload.
2730

2831
This command requires you to be authenticated with either the `--token` option
2932
or using {{man "cargo-login" 1}}.

src/doc/man/generated_txt/cargo-publish.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ DESCRIPTION
1818

1919
2. Create a .crate file by following the steps in cargo-package(1).
2020

21-
3. Upload the crate to the registry. Note that the server will perform
22-
additional checks on the crate.
21+
3. Upload the crate to the registry. The server will perform additional
22+
checks on the crate.
23+
24+
4. The client will poll waiting for the package to appear in the index,
25+
and may timeout. In that case, you will need to check for completion
26+
manually. This timeout does not affect the upload.
2327

2428
This command requires you to be authenticated with either the --token
2529
option or using cargo-login(1).

src/doc/src/commands/cargo-publish.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,11 @@ following steps:
1919
- Checks the `package.publish` key in the manifest for restrictions on
2020
which registries you are allowed to publish to.
2121
2. Create a `.crate` file by following the steps in [cargo-package(1)](cargo-package.html).
22-
3. Upload the crate to the registry. Note that the server will perform
23-
additional checks on the crate.
22+
3. Upload the crate to the registry. The server will perform additional
23+
checks on the crate.
24+
4. The client will poll waiting for the package to appear in the index,
25+
and may timeout. In that case, you will need to check for completion
26+
manually. This timeout does not affect the upload.
2427

2528
This command requires you to be authenticated with either the `--token` option
2629
or using [cargo-login(1)](cargo-login.html).

src/etc/man/cargo-publish.1

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,14 @@ which registries you are allowed to publish to.
2727
.RE
2828
.sp
2929
.RS 4
30-
\h'-04' 3.\h'+01'Upload the crate to the registry. Note that the server will perform
31-
additional checks on the crate.
30+
\h'-04' 3.\h'+01'Upload the crate to the registry. The server will perform additional
31+
checks on the crate.
32+
.RE
33+
.sp
34+
.RS 4
35+
\h'-04' 4.\h'+01'The client will poll waiting for the package to appear in the index,
36+
and may timeout. In that case, you will need to check for completion
37+
manually. This timeout does not affect the upload.
3238
.RE
3339
.sp
3440
This command requires you to be authenticated with either the \fB\-\-token\fR option

0 commit comments

Comments
 (0)