Skip to content

Commit ad740fd

Browse files
authored
Fix man page with malformed {{#options}} block (#15191)
<!-- Thanks for submitting a pull request 🎉! Here are some tips for you: * If this is your first contribution, read "Cargo Contribution Guide" first: https://doc.crates.io/contrib/ * Run `cargo fmt --all` to format your code changes. * Small commits and pull requests are always preferable and easy to review. * If your idea is large and needs feedback from the community, read how: https://doc.crates.io/contrib/process/#working-on-large-features * Cargo takes care of compatibility. Read our design principles: https://doc.crates.io/contrib/design.html * When changing help text of cargo commands, follow the steps to generate docs: https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages * If your PR is not finished, set it as "draft" PR or add "WIP" in its title. * It's ok to use the CI resources to test your PR, but please don't abuse them. --> ### What does this PR try to resolve? The man page template for `cargo publish` includes a malformed `{{#options}}` block containing a freestanding paragraph outside the scope of the `{{#option}}` it relates to. This results in bad formatting in the generated man pages. ### How should we test and review this PR? Review the diffs of the generated man pages.
2 parents ce948f4 + 5e55f52 commit ad740fd

File tree

4 files changed

+18
-21
lines changed

4 files changed

+18
-21
lines changed

src/doc/man/cargo-publish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@ SPEC format. This flag may be specified multiple times and supports common Unix
9595
glob patterns like `*`, `?` and `[]`. However, to avoid your shell accidentally
9696
expanding glob patterns before Cargo handles them, you must use single quotes or
9797
double quotes around each pattern.
98-
{{/option}}
9998

10099
Selecting more than one package with this option is unstable and available only
101100
on the
102101
[nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)
103102
and requires the `-Z package-workspace` flag to enable.
104103
See <https://github.com/rust-lang/cargo/issues/10948> for more information.
104+
{{/option}}
105105

106106
{{#option "`--workspace`" }}
107107
{{actionverb}} all members in the workspace.

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

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,12 @@ OPTIONS
9999
them, you must use single quotes or double quotes around each
100100
pattern.
101101

102-
Selecting more than one package with this option is unstable and available only
103-
104-
on the
105-
106-
[nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)
107-
108-
and requires the `-Z package-workspace` flag to enable.
109-
110-
See <https://github.com/rust-lang/cargo/issues/10948> for more information.
102+
Selecting more than one package with this option is unstable and
103+
available only on the nightly channel
104+
<https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and
105+
requires the -Z package-workspace flag to enable. See
106+
<https://github.com/rust-lang/cargo/issues/10948> for more
107+
information.
111108

112109
--workspace
113110
Publish all members in the workspace.

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,13 @@ See <https://github.com/rust-lang/cargo/issues/10948> for more information.
102102
SPEC format. This flag may be specified multiple times and supports common Unix
103103
glob patterns like <code>*</code>, <code>?</code> and <code>[]</code>. However, to avoid your shell accidentally
104104
expanding glob patterns before Cargo handles them, you must use single quotes or
105-
double quotes around each pattern.</dd>
106-
107-
108-
Selecting more than one package with this option is unstable and available only
105+
double quotes around each pattern.</p>
106+
<p>Selecting more than one package with this option is unstable and available only
109107
on the
110-
[nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)
111-
and requires the `-Z package-workspace` flag to enable.
112-
See <https://github.com/rust-lang/cargo/issues/10948> for more information.
108+
<a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly channel</a>
109+
and requires the <code>-Z package-workspace</code> flag to enable.
110+
See <a href="https://github.com/rust-lang/cargo/issues/10948">https://github.com/rust-lang/cargo/issues/10948</a> for more information.</dd>
111+
113112

114113
<dt class="option-term" id="option-cargo-publish---workspace"><a class="option-anchor" href="#option-cargo-publish---workspace"></a><code>--workspace</code></dt>
115114
<dd class="option-desc">Publish all members in the workspace.</p>

src/etc/man/cargo-publish.1

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,13 @@ SPEC format. This flag may be specified multiple times and supports common Unix
113113
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
114114
expanding glob patterns before Cargo handles them, you must use single quotes or
115115
double quotes around each pattern.
116-
.RE
116+
.sp
117117
Selecting more than one package with this option is unstable and available only
118118
on the
119-
[nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html)
120-
and requires the `-Z package-workspace` flag to enable.
121-
See <https://github.com/rust-lang/cargo/issues/10948> for more information.
119+
\fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html>
120+
and requires the \fB\-Z package\-workspace\fR flag to enable.
121+
See <https://github.com/rust\-lang/cargo/issues/10948> for more information.
122+
.RE
122123
.sp
123124
\fB\-\-workspace\fR
124125
.RS 4

0 commit comments

Comments
 (0)