Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: warn about upload timeout #12733

Merged
merged 2 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/doc/man/cargo-publish.md
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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