Skip to content

Commit

Permalink
Document workspace packaging
Browse files Browse the repository at this point in the history
  • Loading branch information
jneem committed Jun 13, 2024
1 parent a542de2 commit 8cadf16
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
3 changes: 2 additions & 1 deletion src/doc/man/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ cargo-package --- Assemble the local package into a distributable tarball
## DESCRIPTION

This command will create a distributable, compressed `.crate` file with the
source code of the package in the current directory. The resulting file will
source code of the package in the current directory. When run in a workspace,
this command will create one `.crate` file per crate. The resulting file(s) will
be stored in the `target/package` directory. This performs the following
steps:

Expand Down
7 changes: 4 additions & 3 deletions src/doc/man/generated_txt/cargo-package.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ SYNOPSIS

DESCRIPTION
This command will create a distributable, compressed .crate file with
the source code of the package in the current directory. The resulting
file will be stored in the target/package directory. This performs the
following steps:
the source code of the package in the current directory. When run in a
workspace, this command will create one .crate file per crate. The
resulting file(s) will be stored in the target/package directory. This
performs the following steps:

1. Load and check the current workspace, performing some basic checks.
o Path dependencies are not allowed unless they have a version key.
Expand Down
3 changes: 2 additions & 1 deletion src/doc/src/commands/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ cargo-package --- Assemble the local package into a distributable tarball
## DESCRIPTION

This command will create a distributable, compressed `.crate` file with the
source code of the package in the current directory. The resulting file will
source code of the package in the current directory. When run in a workspace,
this command will create one `.crate` file per crate. The resulting file(s) will
be stored in the `target/package` directory. This performs the following
steps:

Expand Down
3 changes: 2 additions & 1 deletion src/etc/man/cargo-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ cargo\-package \[em] Assemble the local package into a distributable tarball
\fBcargo package\fR [\fIoptions\fR]
.SH "DESCRIPTION"
This command will create a distributable, compressed \fB\&.crate\fR file with the
source code of the package in the current directory. The resulting file will
source code of the package in the current directory. When run in a workspace,
this command will create one \fB\&.crate\fR file per crate. The resulting file(s) will
be stored in the \fBtarget/package\fR directory. This performs the following
steps:
.sp
Expand Down

0 comments on commit 8cadf16

Please sign in to comment.