Document the remaining global flags.

speced · Nov 10, 2023 · 62ba7bc · 62ba7bc
1 parent ea48846
commit 62ba7bc
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/docs/index.bs b/docs/index.bs
@@ -673,6 +673,23 @@ so they're specified before the individual commands:
 	you can prevent it from doing the check
 	with `--no-update`.
 
+: `--allow-nonlocal-files`
+: `--allow-execute`
+:: Bikeshed has the ability to include arbitrary files into your spec,
+	and in a few cases the ability to execute shell commands or Python
+	on your behalf
+	(to allow for some extensions).
+
+	By default, these are restricted:
+	you can only include files from the spec's own folder
+	or subfolders,
+	and arbitrary code execution is disallowed.
+
+	If you trust the specs you are processing,
+	and need these abilities, however,
+	the restrictions can be relaxed
+	by passing these flags.
+
 
 `bikeshed spec` {#cli-spec}
 ---------------------------

diff --git a/docs/index.html b/docs/index.html
@@ -1488,9 +1488,9 @@
 		}
 	}
 </style>
-  <meta content="Bikeshed version fdb3bd73b, updated Fri Nov 10 12:00:46 2023 -0800" name="generator">
+  <meta content="Bikeshed version ea48846c9, updated Fri Nov 10 12:07:00 2023 -0800" name="generator">
   <link href="https://speced.github.io/bikeshed/" rel="canonical">
-  <meta content="fdb3bd73bf504aabf33505c1583c9464e325d23b" name="document-revision">
+  <meta content="ea48846c95d33258f573f1c8f29232b0472354eb" name="document-revision">
 <style>/* Boilerplate: style-autolinks */
 .css.css, .property.property, .descriptor.descriptor {
     color: var(--a-normal-text);
@@ -2974,6 +2974,21 @@ <h3 class="heading settled" data-level="3.1" id="cli-options"><span class="secno
 and don’t want to wait for the network to timeout),
 you can prevent it from doing the check
 with <code>--no-update</code>.</p>
+    <dt data-md><code>--allow-nonlocal-files</code>
+    <dt data-md><code>--allow-execute</code>
+    <dd data-md>
+     <p>Bikeshed has the ability to include arbitrary files into your spec,
+and in a few cases the ability to execute shell commands or Python
+on your behalf
+(to allow for some extensions).</p>
+     <p>By default, these are restricted:
+you can only include files from the spec’s own folder
+or subfolders,
+and arbitrary code execution is disallowed.</p>
+     <p>If you trust the specs you are processing,
+and need these abilities, however,
+the restrictions can be relaxed
+by passing these flags.</p>
    </dl>
    <h3 class="heading settled" data-level="3.2" id="cli-spec"><span class="secno">3.2. </span><span class="content"><code>bikeshed spec</code></span><a class="self-link" href="#cli-spec"></a></h3>
    <p>The <code>spec</code> command is the most common one you’ll use.