<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/clippy/rustc_tools_util/README.md - fork/rust @ master</title>
<meta name="description" content="src/tools/clippy/rustc_tools_util/README.md in fork/rust at master.">
<meta property="og:title" content="src/tools/clippy/rustc_tools_util/README.md - fork/rust @ master">
<meta property="og:description" content="src/tools/clippy/rustc_tools_util/README.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/clippy/">clippy</a> / <a href="/fork/rust/ref/master/tree/src/tools/clippy/rustc_tools_util/">rustc_tools_util</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.5 KiB</span><span>62 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/e197ea048a0af4f343e5d190dde0de2405f0b2c2/src/tools/clippy/rustc_tools_util/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>rustc_tools_util</h1>
<p>A small tool to help you generate version information
for packages installed from a git repo</p>
<h2>Usage</h2>
<p>Add a <code>build.rs</code> file to your repo and list it in <code>Cargo.toml</code></p>
<pre class="language-toml"><a-pr>build</a-pr> <a-o>=</a-o> <a-s>&quot;build.rs&quot;</a-s></pre>
<p>List rustc_tools_util as regular AND build dependency.</p>
<pre class="language-toml"><a-p>[</a-p><a-pr>dependencies</a-pr><a-p>]</a-p>
<a-pr>rustc_tools_util</a-pr> <a-o>=</a-o> <a-s>&quot;0.3.0&quot;</a-s>

<a-p>[</a-p><a-pr>build-dependencies</a-pr><a-p>]</a-p>
<a-pr>rustc_tools_util</a-pr> <a-o>=</a-o> <a-s>&quot;0.3.0&quot;</a-s></pre>
<p>In <code>build.rs</code>, generate the data in your <code>main()</code></p>
<pre class="language-rust"><a-k>fn</a-k> <a-f>main</a-f><a-p>()</a-p> <a-p>{</a-p>
    rustc_tools_util<a-p>::</a-p>setup_version_info!<a-p>();</a-p>
<a-p>}</a-p></pre>
<p>Use the version information in your main.rs</p>
<pre class="language-rust"><a-k>fn</a-k> <a-f>show_version</a-f><a-p>()</a-p> <a-p>{</a-p>
    <a-k>let</a-k> version_info = rustc_tools_util<a-p>::</a-p>get_version_info!<a-p>();</a-p>
    <a-m>println!</a-m><a-p>(</a-p><a-s>&quot;{}&quot;</a-s><a-p>,</a-p> version_info<a-p>);</a-p>
<a-p>}</a-p></pre>
<p>This gives the following output in clippy:
<code>clippy 0.1.66 (a28f3c8 2022-11-20)</code></p>
<h2>Repository</h2>
<p>This project is part of the rust-lang/rust-clippy repository. The source code
can be found under <code>./rustc_tools_util/</code>.</p>
<p>The changelog for <code>rustc_tools_util</code> is available under:
<a href="https://github.com/rust-lang/rust-clippy/blob/master/rustc_tools_util/CHANGELOG.md"><code>rustc_tools_util/CHANGELOG.md</code></a></p>
<h2>License</h2>
&lt;!-- REUSE-IgnoreStart --&gt;
<p>Copyright 2014-2022 The Rust Project Developers</p>
<p>Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
&lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your
option. All files in the project carrying such notice may not be
copied, modified, or distributed except according to those terms.</p>
&lt;!-- REUSE-IgnoreEnd --&gt;
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/clippy/rustc_tools_util/README.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># rustc_tools_util</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">A small tool to help you generate version information</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">for packages installed from a git repo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">## Usage</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">Add a `build.rs` file to your repo and list it in `Cargo.toml`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">````toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">build = &quot;build.rs&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">````</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">List rustc_tools_util as regular AND build dependency.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">````toml</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">[dependencies]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">rustc_tools_util = &quot;0.3.0&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">[build-dependencies]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">rustc_tools_util = &quot;0.3.0&quot;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">````</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">In `build.rs`, generate the data in your `main()`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">```rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">fn main() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">    rustc_tools_util::setup_version_info!();</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">Use the version information in your main.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text">```rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">fn show_version() {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">    let version_info = rustc_tools_util::get_version_info!();</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text">    println!(&quot;{}&quot;, version_info);</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">This gives the following output in clippy:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">`clippy 0.1.66 (a28f3c8 2022-11-20)`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">## Repository</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">This project is part of the rust-lang/rust-clippy repository. The source code</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">can be found under `./rustc_tools_util/`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text">The changelog for `rustc_tools_util` is available under:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">[`rustc_tools_util/CHANGELOG.md`](https://github.com/rust-lang/rust-clippy/blob/master/rustc_tools_util/CHANGELOG.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">&lt;!-- REUSE-IgnoreStart --&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">Copyright 2014-2022 The Rust Project Developers</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text">http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">&lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">option. All files in the project carrying such notice may not be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">copied, modified, or distributed except according to those terms.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">&lt;!-- REUSE-IgnoreEnd --&gt;</span></span></pre></div></div>
</main>
</body>
</html>
