Skip to content

Commit

Permalink
chore: cargo build-man
Browse files Browse the repository at this point in the history
  • Loading branch information
sourcefrog committed Oct 15, 2024
1 parent 83ae3b7 commit b8125da
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 40 deletions.
15 changes: 3 additions & 12 deletions src/doc/man/generated_txt/cargo-package.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,9 @@ DESCRIPTION

o Symlinks are flattened to their target files.

o Subdirectories containing Cargo.toml are excluded, as they are
assumed to be separate packages.

o A target directory in the root of the package is excluded.

o Files and directories matching the [include] and [exclude] fields
in the manifest are included or excluded. Include patterns can
override the following rules.

o Files that are ignored by VCS are excluded.

o Unix hidden files and directories (starting with .) are excluded.
o Files and directories are included or excluded based on rules
mentioned in the [include] and [exclude] fields
<https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields>.

3. Extract the .crate file and build it to verify it can build.

Expand Down
10 changes: 2 additions & 8 deletions src/doc/src/commands/cargo-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,8 @@ stored in the `target/package` directory. This performs the following steps:
about the current VCS checkout hash if available, as well as a flag if the
worktree is dirty.
- Symlinks are flattened to their target files.
- Subdirectories containing `Cargo.toml` are excluded, as they are assumed
to be separate packages.
- A `target` directory in the root of the package is excluded.
- Files and directories matching the `[include]` and `[exclude]` fields in
the manifest are included or excluded. Include patterns can override the
following rules.
- Files that are ignored by VCS are excluded.
- Unix hidden files and directories (starting with `.`) are excluded.
- Files and directories are included or excluded based on rules mentioned in
[the `[include]` and `[exclude]` fields](../reference/manifest.html#the-exclude-and-include-fields).

3. Extract the `.crate` file and build it to verify it can build.
- This will rebuild your package from scratch to ensure that it can be
Expand Down
22 changes: 2 additions & 20 deletions src/etc/man/cargo-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -51,26 +51,8 @@ worktree is dirty.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+02'Subdirectories containing \fBCargo.toml\fR are excluded, as they are assumed
to be separate packages.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+02'A \fBtarget\fR directory in the root of the package is excluded.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+02'Files and directories matching the \fB[include]\fR and \fB[exclude]\fR fields in
the manifest are included or excluded. Include patterns can override the
following rules.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+02'Files that are ignored by VCS are excluded.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+02'Unix hidden files and directories (starting with \fB\&.\fR) are excluded.
\h'-04'\(bu\h'+02'Files and directories are included or excluded based on rules mentioned in
\fIthe \f(BI[include]\fI and \f(BI[exclude]\fI fields\fR <https://doc.rust\-lang.org/cargo/reference/manifest.html#the\-exclude\-and\-include\-fields>\&.
.RE
.RE
.sp
Expand Down

0 comments on commit b8125da

Please sign in to comment.