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.

Sign up for GitHub

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

Jump to bottom

Updated display message of cargo metadata --help #9010

Closed
wants to merge 4 commits into from
Closed

Updated display message of cargo metadata --help #9010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0cc892b
Update display message for cargo metadata
bishtpawan Dec 22, 2020
0d2e1e5
Update mdman.md file
bishtpawan Dec 22, 2020
13687cd
Update cargo-metadata
bishtpawan Dec 22, 2020
2ddd116
Update help message
bishtpawan Dec 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions crates/mdman/doc/out/mdman.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ man page:

<dl>

<dt><code>-t</code> <em>type</em></dt>
<dd>Specifies the output type. The following output types are supported:</p>
<dt class="option-term" id="option-mdman--t"><a class="option-anchor" href="#option-mdman--t"></a><code>-t</code> <em>type</em></dt>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem to be some unrelated changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I thought we need to update the man page if we are updating any details. That's why this file got updated.
No worries I'll remove these changes.

Thanks for your response.

<dd class="option-desc">Specifies the output type. The following output types are supported:</p>
<ul>
<li><code>man</code> — A troff-style man page. Outputs with a numbered extension (like
<code>.1</code>) matching the man page section.</li>
Expand All @@ -66,24 +66,24 @@ available. Outputs with the <code>.txt</code> extension.</li>
</ul></dd>


<dt><code>-o</code> <em>outdir</em></dt>
<dd>Specifies the directory where to save the output.</dd>
<dt class="option-term" id="option-mdman--o"><a class="option-anchor" href="#option-mdman--o"></a><code>-o</code> <em>outdir</em></dt>
<dd class="option-desc">Specifies the directory where to save the output.</dd>


<dt><code>--url</code> <em>base_url</em></dt>
<dd>Specifies a base URL to use for relative URLs within the document. Any
<dt class="option-term" id="option-mdman---url"><a class="option-anchor" href="#option-mdman---url"></a><code>--url</code> <em>base_url</em></dt>
<dd class="option-desc">Specifies a base URL to use for relative URLs within the document. Any
relative URL will be joined with this URL.</dd>


<dt><code>--man</code> <em>name</em><code>:</code><em>section</em><code>=</code><em>url</em></dt>
<dd>Specifies a URL to use for the given man page. When the <code>{{man name section}}</code> expression is used, the given URL will be inserted as a link. This
<dt class="option-term" id="option-mdman---man"><a class="option-anchor" href="#option-mdman---man"></a><code>--man</code> <em>name</em><code>:</code><em>section</em><code>=</code><em>url</em></dt>
<dd class="option-desc">Specifies a URL to use for the given man page. When the <code>{{man name section}}</code> expression is used, the given URL will be inserted as a link. This
may be specified multiple times. If a man page reference does not have a
matching <code>--man</code> entry, then a relative link to a file named <em>name</em><code>.md</code> will
be used.</dd>


<dt><em>sources...</em></dt>
<dd>The source input filename, may be specified multiple times.</dd>
<dt class="option-term" id="option-mdman-sources..."><a class="option-anchor" href="#option-mdman-sources..."></a><em>sources...</em></dt>
<dd class="option-desc">The source input filename, may be specified multiple times.</dd>


</dl>
Expand Down
2 changes: 1 addition & 1 deletion src/bin/cargo/commands/metadata.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pub fn cli() -> App {
the concrete used versions including overrides, \
in machine-readable format",
)
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("quiet", "Do not print cargo log messages").short("q"))
.arg_features()
.arg(multi_opt(
"filter-platform",
Expand Down