<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ci/validate-man.sh - fork/cargo @ home-0.5.12</title>
<meta name="description" content="ci/validate-man.sh in fork/cargo at home-0.5.12.">
<meta property="og:title" content="ci/validate-man.sh - fork/cargo @ home-0.5.12">
<meta property="og:description" content="ci/validate-man.sh in fork/cargo at home-0.5.12.">
<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="home-0.5.12" data-tip="4f15cc8882fb34bf70c945e9c8ae91d6c8c91757">
<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/cargo</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/cargo</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="393ce5b41632173199d3b996de9c8a89f6290435">Auto merge of #12048 - weihanglo:mdman, r=epage</span><span class="snapshot-sha sha" data-commit="393ce5b41632173199d3b996de9c8a89f6290435">393ce5b41</span><time datetime="2023-04-28T15:48:53+00:00" title="2023-04-28 15:48:53 +0000">2023-04-28</time></p>
<header class="topbar"><details class="switcher"><summary>home-0.5.12</summary><div class="menu"><strong>branches</strong><a href="/fork/cargo/ref/master/">master</a><strong>tags</strong><a href="/fork/cargo/ref/0.87.0/">0.87.0</a><a href="/fork/cargo/ref/0.88.0/">0.88.0</a><a href="/fork/cargo/ref/0.89.0/">0.89.0</a><a href="/fork/cargo/ref/0.90.0/">0.90.0</a><a href="/fork/cargo/ref/0.91.0/">0.91.0</a><a href="/fork/cargo/ref/0.92.0/">0.92.0</a><a href="/fork/cargo/ref/0.93.0/">0.93.0</a><a class="current" href="/fork/cargo/ref/home-0.5.12/">home-0.5.12</a><a class="all" href="/fork/cargo/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/cargo/">cargo</a> / <a href="/fork/cargo/ref/home-0.5.12/tree/ci/">ci</a> / <span class="cur">validate-man.sh</span></nav>
<span class="view-stats"><span>597 B</span><span>27 lines</span></span><span class="actions"><a class="raw" href="/fork/cargo/raw/a3f114214dddf96884cb36e782a1d74ab847cbdd/ci/validate-man.sh">raw</a></span></header>
<pre class="code src language-bash"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>#!/bin/bash</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-c># This script validates that there aren&#39;t any changes to the man pages.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-f>set</a-f> <a-co>-e</a-co></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"><a-pr>cargo_man</a-pr>=<a-s>&quot;src/doc&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-pr>mdman_man</a-pr>=<a-s>&quot;crates/mdman/doc&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-pr>changes</a-pr>=<a-eb>$(</a-eb><a-f>git</a-f><a-eb> status </a-eb><a-co>--porcelain</a-co><a-eb> </a-eb><a-co>--</a-co><a-eb> </a-eb><a-o>$</a-o><a-pr>cargo_man</a-pr><a-eb> </a-eb><a-o>$</a-o><a-pr>mdman_man</a-pr><a-eb>)</a-eb></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-k>if</a-k> [ -n <a-s>&quot;</a-s><a-o>$</a-o><a-pr>changes</a-pr><a-s>&quot;</a-s> ]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">    <a-f>echo</a-f> <a-s>&quot;git directory must be clean before running this script.&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">    <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-k>fi</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-f>cargo</a-f> build-man</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"><a-pr>changes</a-pr>=<a-eb>$(</a-eb><a-f>git</a-f><a-eb> status </a-eb><a-co>--porcelain</a-co><a-eb> </a-eb><a-co>--</a-co><a-eb> </a-eb><a-o>$</a-o><a-pr>cargo_man</a-pr><a-eb> </a-eb><a-o>$</a-o><a-pr>mdman_man</a-pr><a-eb>)</a-eb></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-k>if</a-k> [ -n <a-s>&quot;</a-s><a-o>$</a-o><a-pr>changes</a-pr><a-s>&quot;</a-s> ]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-k>then</a-k></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">    <a-f>echo</a-f> <a-s>&quot;Detected changes of man pages:&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">    <a-f>echo</a-f> <a-s>&quot;</a-s><a-o>$</a-o><a-pr>changes</a-pr><a-s>&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">    <a-f>echo</a-f></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">    <a-f>echo</a-f> <a-s>&#39;Please run `cargo build-man` to rebuild the man pages&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">    <a-f>echo</a-f> <a-s>&quot;and commit the changes.&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">    <a-f>exit</a-f> 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-k>fi</a-k></span></span></pre>
</main>
</body>
</html>
