ceedling 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/GIT_COMMIT_SHA +1 -1
- data/README.md +47 -50
- data/Rakefile +3 -2
- data/bin/app_cfg.rb +21 -0
- data/bin/cli_handler.rb +7 -1
- data/bin/cli_helper.rb +5 -0
- data/docs/Changelog.md +10 -0
- data/docs/overrides/main.html +11 -8
- data/lib/ceedling/config/configurator.rb +5 -2
- data/lib/ceedling/config/configurator_setup.rb +26 -15
- data/lib/ceedling/file_wrapper.rb +56 -26
- data/lib/ceedling/rake_app/test_task_name.rb +29 -0
- data/lib/ceedling/rakefile.rb +1 -0
- data/lib/ceedling/rakefiles/tests/rules_tests.rake +3 -20
- data/lib/ceedling/rakefiles/tests/rules_tests_generate.rake +4 -30
- data/lib/ceedling/setupinator.rb +4 -0
- data/lib/ceedling/test_invoker/test_build_executor.rb +18 -1
- data/lib/version.rb +1 -1
- data/plugins/bullseye/bullseye.rake +6 -9
- data/plugins/gcov/gcov.rake +6 -9
- data/plugins/sanitize/sanitize.rake +6 -6
- data/plugins/valgrind/valgrind.rake +6 -6
- data/site-local/404.html +6 -20
- data/site-local/assets/javascripts/{bundle.d7400e89.min.js → bundle.c21346df.min.js} +3 -3
- data/site-local/assets/javascripts/{bundle.d7400e89.min.js.map → bundle.c21346df.min.js.map} +2 -2
- data/site-local/assets/javascripts/workers/{search.2c215733.min.js → search.a7633da7.min.js} +2 -2
- data/site-local/assets/javascripts/workers/{search.2c215733.min.js.map → search.a7633da7.min.js.map} +1 -1
- data/site-local/assets/stylesheets/main.57a0d79d.min.css +6 -0
- data/site-local/assets/stylesheets/main.57a0d79d.min.css.map +1 -0
- data/site-local/assets/stylesheets/palette.fb2fffe2.min.css +4 -0
- data/site-local/assets/stylesheets/palette.fb2fffe2.min.css.map +1 -0
- data/site-local/configuration/environment-vars.html +6 -20
- data/site-local/configuration/global-collections.html +6 -20
- data/site-local/configuration/index.html +6 -20
- data/site-local/configuration/loading.html +6 -20
- data/site-local/configuration/mixins.html +10 -24
- data/site-local/configuration/parallel-builds.html +6 -20
- data/site-local/configuration/project-file.html +8 -22
- data/site-local/configuration/reference/cexception.html +6 -20
- data/site-local/configuration/reference/cmock.html +6 -20
- data/site-local/configuration/reference/defines.html +16 -30
- data/site-local/configuration/reference/environment.html +10 -24
- data/site-local/configuration/reference/extension.html +6 -20
- data/site-local/configuration/reference/files.html +13 -27
- data/site-local/configuration/reference/flags.html +13 -27
- data/site-local/configuration/reference/index.html +6 -20
- data/site-local/configuration/reference/libraries.html +6 -20
- data/site-local/configuration/reference/mixins.html +6 -20
- data/site-local/configuration/reference/partials.html +6 -20
- data/site-local/configuration/reference/paths.html +11 -25
- data/site-local/configuration/reference/plugins.html +6 -20
- data/site-local/configuration/reference/project.html +16 -30
- data/site-local/configuration/reference/release-build.html +6 -20
- data/site-local/configuration/reference/test-build.html +6 -20
- data/site-local/configuration/reference/test-runner.html +6 -20
- data/site-local/configuration/reference/tools.html +18 -32
- data/site-local/configuration/reference/unity.html +6 -20
- data/site-local/configuration/which-ceedling.html +6 -20
- data/site-local/development/index.html +6 -20
- data/site-local/development/plugins/configuration.html +6 -20
- data/site-local/development/plugins/index.html +6 -20
- data/site-local/development/plugins/plugin-subclass.html +54 -68
- data/site-local/development/plugins/rake-tasks.html +8 -22
- data/site-local/development/releases.html +79 -28
- data/site-local/development/workflow.html +14 -28
- data/site-local/getting-started/builds.html +6 -20
- data/site-local/getting-started/command-line.html +6 -20
- data/site-local/getting-started/example-projects/cipher-quest.html +6 -20
- data/site-local/getting-started/example-projects/index.html +6 -20
- data/site-local/getting-started/example-projects/temp-sensor.html +6 -20
- data/site-local/getting-started/example-projects/wondrous-forest.html +6 -20
- data/site-local/getting-started/index.html +6 -20
- data/site-local/getting-started/installation.html +6 -20
- data/site-local/getting-started/quick-start.html +6 -20
- data/site-local/help.html +6 -20
- data/site-local/index.html +11 -24
- data/site-local/overview/build-system.html +6 -20
- data/site-local/overview/index.html +6 -20
- data/site-local/overview/test-environments.html +6 -20
- data/site-local/overview/tools-and-frameworks.html +6 -20
- data/site-local/plugins/beep.html +6 -20
- data/site-local/plugins/bullseye/index.html +13 -24
- data/site-local/plugins/bullseye/licensing.html +14 -28
- data/site-local/plugins/command-hooks.html +8 -22
- data/site-local/plugins/compile-commands-json-db.html +6 -20
- data/site-local/plugins/cppcheck.html +8 -22
- data/site-local/plugins/dependencies.html +10 -24
- data/site-local/plugins/fff.html +7 -21
- data/site-local/plugins/gcov/examples.html +7 -21
- data/site-local/plugins/gcov/gcovr.html +7 -21
- data/site-local/plugins/gcov/index.html +6 -20
- data/site-local/plugins/gcov/overview.html +9 -20
- data/site-local/plugins/gcov/reportgenerator.html +9 -23
- data/site-local/plugins/gcov/reporting.html +6 -20
- data/site-local/plugins/gcov/setup.html +6 -20
- data/site-local/plugins/gcov/tool-versions.html +6 -20
- data/site-local/plugins/gcov/troubleshooting.html +10 -24
- data/site-local/plugins/index.html +6 -20
- data/site-local/plugins/module-generator.html +21 -35
- data/site-local/plugins/report-build-warnings-log.html +53 -67
- data/site-local/plugins/report-tests-gtestlike-stdout.html +6 -20
- data/site-local/plugins/report-tests-ide-stdout.html +43 -57
- data/site-local/plugins/report-tests-log-factory.html +50 -64
- data/site-local/plugins/report-tests-pretty-stdout.html +7 -21
- data/site-local/plugins/report-tests-raw-output-log.html +6 -20
- data/site-local/plugins/report-tests-teamcity-stdout.html +16 -30
- data/site-local/plugins/sanitize.html +54 -64
- data/site-local/plugins/valgrind.html +46 -56
- data/site-local/project/index.html +6 -20
- data/site-local/project/release-history.html +6 -20
- data/site-local/project/sbom.html +6 -20
- data/site-local/project/upgrade.html +6 -20
- data/site-local/reference/build-directives.html +6 -20
- data/site-local/reference/command-line.html +6 -20
- data/site-local/reference/environment-vars.html +6 -20
- data/site-local/reference/gcov-plugin.html +6 -20
- data/site-local/reference/global-collections.html +6 -20
- data/site-local/reference/index.html +6 -20
- data/site-local/reference/partials-macros.html +6 -20
- data/site-local/reference/project-configuration.html +6 -20
- data/site-local/sitemap.xml.gz +0 -0
- data/site-local/snapshot/examples/cipher_quest/index.html +16 -30
- data/site-local/snapshot/examples/temp_sensor/index.html +8 -22
- data/site-local/snapshot/examples/wondrous_forest/index.html +6 -20
- data/site-local/testing-guide/build-directives.html +14 -28
- data/site-local/testing-guide/conventions.html +13 -27
- data/site-local/testing-guide/frameworks.html +11 -25
- data/site-local/testing-guide/index.html +6 -20
- data/site-local/testing-guide/partials/configuration.html +8 -22
- data/site-local/testing-guide/partials/conventions.html +8 -22
- data/site-local/testing-guide/partials/directives.html +16 -30
- data/site-local/testing-guide/partials/example.html +14 -28
- data/site-local/testing-guide/partials/index.html +6 -20
- data/site-local/testing-guide/partials/overview.html +6 -20
- data/site-local/testing-guide/partials/variables.html +11 -25
- data/site-local/testing-guide/test-cases.html +13 -27
- data/site-local/testing-guide/test-sample.html +12 -26
- data/site-local/testing-guide/test-suite-anatomy.html +6 -20
- data/spec/integration/configurator_pipeline_spec.rb +10 -0
- data/spec/integration/dependencies/dependency_tracker_core_spec.rb +40 -0
- data/spec/integration/rake_task_registry_plugins_spec.rb +95 -0
- data/spec/integration/vendor_copy_transient_io_retry_spec.rb +122 -74
- data/spec/support/integration/configurator_integration_helper.rb +4 -1
- data/spec/units/bin/app_cfg_spec.rb +10 -0
- data/spec/units/bin/cli_handler_spec.rb +2 -1
- data/spec/units/bin/cli_helper_spec.rb +10 -0
- data/spec/units/config/configurator_setup_spec.rb +61 -43
- data/spec/units/config/configurator_spec.rb +10 -1
- data/spec/units/file_wrapper_spec.rb +66 -27
- data/spec/units/rake_app/test_task_name_spec.rb +47 -0
- data/spec/units/test_build_executor_spec.rb +42 -2
- metadata +16 -11
- data/site-local/assets/stylesheets/main.ec1eaa64.min.css +0 -1
- data/site-local/assets/stylesheets/main.ec1eaa64.min.css.map +0 -1
- data/site-local/assets/stylesheets/palette.ab4e12ef.min.css +0 -1
- data/site-local/assets/stylesheets/palette.ab4e12ef.min.css.map +0 -1
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
22
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
22
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -27,10 +27,10 @@
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
|
|
30
|
-
<link rel="stylesheet" href="../../assets/stylesheets/main.
|
|
30
|
+
<link rel="stylesheet" href="../../assets/stylesheets/main.57a0d79d.min.css">
|
|
31
31
|
|
|
32
32
|
|
|
33
|
-
<link rel="stylesheet" href="../../assets/stylesheets/palette.
|
|
33
|
+
<link rel="stylesheet" href="../../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
@@ -87,30 +87,16 @@
|
|
|
87
87
|
</div>
|
|
88
88
|
<div data-md-component="announce">
|
|
89
89
|
|
|
90
|
-
<aside class="md-banner">
|
|
91
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
</div>
|
|
97
|
-
|
|
98
|
-
</aside>
|
|
99
|
-
|
|
100
90
|
</div>
|
|
101
91
|
|
|
102
92
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
103
93
|
|
|
104
94
|
<aside class="md-banner md-banner--warning">
|
|
105
95
|
<div class="md-banner__inner md-grid md-typeset">
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
You are not viewing the latest version.
|
|
96
|
+
You are not viewing the latest version.
|
|
109
97
|
<a href="../../..">
|
|
110
98
|
<strong>Click here to go to latest.</strong>
|
|
111
99
|
</a>
|
|
112
|
-
|
|
113
|
-
|
|
114
100
|
</div>
|
|
115
101
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
116
102
|
</aside>
|
|
@@ -4416,9 +4402,9 @@
|
|
|
4416
4402
|
</div>
|
|
4417
4403
|
<h2 id="example-rake-task">Example Rake task</h2>
|
|
4418
4404
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Only tasks with description are listed by `ceedling -T`</span>
|
|
4419
|
-
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="n">desc</span><span class="w"> </span><span class="s2"
|
|
4405
|
+
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="n">desc</span><span class="w"> </span><span class="s2">"Print hello world to console"</span>
|
|
4420
4406
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="n">task</span><span class="w"> </span><span class="ss">:hello_world</span><span class="w"> </span><span class="k">do</span>
|
|
4421
|
-
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="n">sh</span><span class="w"> </span><span class="s2"
|
|
4407
|
+
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="n">sh</span><span class="w"> </span><span class="s2">"echo Hello World!"</span>
|
|
4422
4408
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="k">end</span>
|
|
4423
4409
|
</code></pre></div>
|
|
4424
4410
|
<p>Resulting, example command line:</p>
|
|
@@ -4518,10 +4504,10 @@ See <a href="../../getting-started/builds.html">Delta Builds</a> for how this tr
|
|
|
4518
4504
|
|
|
4519
4505
|
|
|
4520
4506
|
|
|
4521
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.
|
|
4507
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4522
4508
|
|
|
4523
4509
|
|
|
4524
|
-
<script src="../../assets/javascripts/bundle.
|
|
4510
|
+
<script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
4525
4511
|
|
|
4526
4512
|
|
|
4527
4513
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.57a0d79d.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
<link rel="stylesheet" href="../assets/stylesheets/palette.
|
|
35
|
+
<link rel="stylesheet" href="../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -89,30 +89,16 @@
|
|
|
89
89
|
</div>
|
|
90
90
|
<div data-md-component="announce">
|
|
91
91
|
|
|
92
|
-
<aside class="md-banner">
|
|
93
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</aside>
|
|
101
|
-
|
|
102
92
|
</div>
|
|
103
93
|
|
|
104
94
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
105
95
|
|
|
106
96
|
<aside class="md-banner md-banner--warning">
|
|
107
97
|
<div class="md-banner__inner md-grid md-typeset">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
You are not viewing the latest version.
|
|
98
|
+
You are not viewing the latest version.
|
|
111
99
|
<a href="../..">
|
|
112
100
|
<strong>Click here to go to latest.</strong>
|
|
113
101
|
</a>
|
|
114
|
-
|
|
115
|
-
|
|
116
102
|
</div>
|
|
117
103
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
118
104
|
</aside>
|
|
@@ -4143,6 +4129,23 @@
|
|
|
4143
4129
|
</span>
|
|
4144
4130
|
</a>
|
|
4145
4131
|
|
|
4132
|
+
<nav class="md-nav" aria-label="Documentation deployment">
|
|
4133
|
+
<ul class="md-nav__list">
|
|
4134
|
+
|
|
4135
|
+
<li class="md-nav__item">
|
|
4136
|
+
<a href="#revising-an-earlier-versions-documentation" class="md-nav__link">
|
|
4137
|
+
<span class="md-ellipsis">
|
|
4138
|
+
|
|
4139
|
+
Revising an earlier version’s documentation
|
|
4140
|
+
|
|
4141
|
+
</span>
|
|
4142
|
+
</a>
|
|
4143
|
+
|
|
4144
|
+
</li>
|
|
4145
|
+
|
|
4146
|
+
</ul>
|
|
4147
|
+
</nav>
|
|
4148
|
+
|
|
4146
4149
|
</li>
|
|
4147
4150
|
|
|
4148
4151
|
</ul>
|
|
@@ -4453,6 +4456,23 @@
|
|
|
4453
4456
|
</span>
|
|
4454
4457
|
</a>
|
|
4455
4458
|
|
|
4459
|
+
<nav class="md-nav" aria-label="Documentation deployment">
|
|
4460
|
+
<ul class="md-nav__list">
|
|
4461
|
+
|
|
4462
|
+
<li class="md-nav__item">
|
|
4463
|
+
<a href="#revising-an-earlier-versions-documentation" class="md-nav__link">
|
|
4464
|
+
<span class="md-ellipsis">
|
|
4465
|
+
|
|
4466
|
+
Revising an earlier version’s documentation
|
|
4467
|
+
|
|
4468
|
+
</span>
|
|
4469
|
+
</a>
|
|
4470
|
+
|
|
4471
|
+
</li>
|
|
4472
|
+
|
|
4473
|
+
</ul>
|
|
4474
|
+
</nav>
|
|
4475
|
+
|
|
4456
4476
|
</li>
|
|
4457
4477
|
|
|
4458
4478
|
</ul>
|
|
@@ -4533,9 +4553,17 @@ release.</p>
|
|
|
4533
4553
|
<li><code>master</code> holds the latest release and subsequent patch releases.</li>
|
|
4534
4554
|
<li><code>next_version</code> holds the next minor or major release.</li>
|
|
4535
4555
|
</ul>
|
|
4536
|
-
<p>Both branches are protected. Changes reach them only through
|
|
4537
|
-
|
|
4538
|
-
force-pushes, and branch deletion are blocked
|
|
4556
|
+
<p>Both branches are protected by a GitHub ruleset. Changes reach them only through
|
|
4557
|
+
pull requests, and a pull request merges only once the <strong>CI Gate</strong> check passes.
|
|
4558
|
+
Direct pushes, force-pushes, and branch deletion are blocked. Only a maintainer
|
|
4559
|
+
merges a pull request.</p>
|
|
4560
|
+
<p>CI Gate reduces every CI job to one result. A pull request that changes only
|
|
4561
|
+
documentation skips the test suites and still passes CI Gate, so it is ready to
|
|
4562
|
+
merge in minutes. The development workflow guide describes <a href="https://github.com/ThrowTheSwitch/Ceedling/blob/master/.github/WORKFLOWS.md">what counts as
|
|
4563
|
+
documentation</a>.</p>
|
|
4564
|
+
<p>Maintainers squash-merge community pull requests, so each lands as one commit
|
|
4565
|
+
attributed to its author. Maintainers may merge their own branches with a merge
|
|
4566
|
+
commit to keep their history.</p>
|
|
4539
4567
|
<h3 id="patch-work">Patch work</h3>
|
|
4540
4568
|
<p>Branch from <code>master</code> for a patch fix. Open the pull request against <code>master</code>.</p>
|
|
4541
4569
|
<p>Short-lived topic branches are the norm. Delete the branch once the pull request
|
|
@@ -4546,13 +4574,16 @@ merges.</p>
|
|
|
4546
4574
|
<p><code>rake lint:changed</code> assumes this. It compares against <code>next_version</code> unless you
|
|
4547
4575
|
name another branch or revision.</p>
|
|
4548
4576
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span>lint:changed
|
|
4549
|
-
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2"
|
|
4577
|
+
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2">"lint:changed[master]"</span>
|
|
4550
4578
|
</code></pre></div>
|
|
4551
4579
|
<h2 id="tags-drive-releases">Tags drive releases</h2>
|
|
4552
4580
|
<p>Pushing a tag publishes. Nothing else does.</p>
|
|
4553
4581
|
<p>Full releases are tagged on <code>master</code>. Pre-releases are tagged on <code>next_version</code>.
|
|
4554
4582
|
Neither workflow checks which branch a tag points at, so the convention is yours
|
|
4555
4583
|
to keep.</p>
|
|
4584
|
+
<p>Only repository administrators can create, move, or delete <code>v</code> tags. A pushed
|
|
4585
|
+
release tag is left where it is, so a published version always points at the code
|
|
4586
|
+
it was built from.</p>
|
|
4556
4587
|
<table>
|
|
4557
4588
|
<thead>
|
|
4558
4589
|
<tr>
|
|
@@ -4565,17 +4596,22 @@ to keep.</p>
|
|
|
4565
4596
|
<tr>
|
|
4566
4597
|
<td><code>v1.2.0</code></td>
|
|
4567
4598
|
<td><code>release.yml</code></td>
|
|
4568
|
-
<td>GitHub release</td>
|
|
4599
|
+
<td>GitHub release, and the gem published to RubyGems.org</td>
|
|
4569
4600
|
</tr>
|
|
4570
4601
|
<tr>
|
|
4571
4602
|
<td><code>v1.2.0-pre.1</code></td>
|
|
4572
4603
|
<td><code>prerelease.yml</code></td>
|
|
4573
|
-
<td>GitHub pre-release</td>
|
|
4604
|
+
<td>GitHub pre-release only</td>
|
|
4574
4605
|
</tr>
|
|
4575
4606
|
</tbody>
|
|
4576
4607
|
</table>
|
|
4577
4608
|
<p>A hyphenated suffix becomes a dot in the gem version, which is RubyGems
|
|
4578
4609
|
pre-release notation. Tag <code>v1.2.0-pre.1</code> builds <code>ceedling-1.2.0.pre.1.gem</code>.</p>
|
|
4610
|
+
<p>A full release reaches RubyGems.org through <a href="https://guides.rubygems.org/trusted-publishing/">trusted publishing</a>. The release
|
|
4611
|
+
workflow exchanges its own GitHub identity for a short-lived RubyGems credential
|
|
4612
|
+
and pushes the gem it built. No maintainer holds or handles an API key.
|
|
4613
|
+
Pre-release gems are attached to the GitHub pre-release and never pushed to
|
|
4614
|
+
RubyGems.org.</p>
|
|
4579
4615
|
<div class="admonition warning">
|
|
4580
4616
|
<p class="admonition-title">Warning</p>
|
|
4581
4617
|
<p>Neither workflow runs the test suite. Both build and publish directly from the
|
|
@@ -4618,8 +4654,7 @@ release, then commit and continue development.</p>
|
|
|
4618
4654
|
<li>Push <code>v1.2.0-pre.1</code> from <code>next_version</code>. CI creates a GitHub-available pre-release.</li>
|
|
4619
4655
|
<li>Iterate with <code>-pre.2</code> and onward as needed.</li>
|
|
4620
4656
|
<li>Bring the work onto <code>master</code> once the release is ready.</li>
|
|
4621
|
-
<li>Push <code>v1.2.0</code> from <code>master</code>. CI creates the GitHub-available release.</li>
|
|
4622
|
-
<li>A maintainer with RubyGems permissions downloads the Ceedling gem from (4) and manually pushes to RubyGems.org.</li>
|
|
4657
|
+
<li>Push <code>v1.2.0</code> from <code>master</code>. CI creates the GitHub-available release and publishes the gem to RubyGems.org.</li>
|
|
4623
4658
|
<li>Bump <code>lib/version.rb</code> and continue development.</li>
|
|
4624
4659
|
</ol>
|
|
4625
4660
|
<h2 id="documentation-deployment">Documentation deployment</h2>
|
|
@@ -4630,6 +4665,22 @@ take a bare version number rather than a tag.</p>
|
|
|
4630
4665
|
</code></pre></div>
|
|
4631
4666
|
<p>The full task list is in the <a href="workflow.html#documentation">documentation section</a> of the development
|
|
4632
4667
|
workflow guide.</p>
|
|
4668
|
+
<h3 id="revising-an-earlier-versions-documentation">Revising an earlier version’s documentation</h3>
|
|
4669
|
+
<p>Once a newer release becomes <code>latest</code>, its <code>docs/mkdocs/</code> content is the primary
|
|
4670
|
+
source of the published site. An earlier version’s published documentation can
|
|
4671
|
+
still need an occasional revision. A <code>docs-</code> tag records the source of each such
|
|
4672
|
+
version’s published documentation.</p>
|
|
4673
|
+
<ol>
|
|
4674
|
+
<li>Branch from the version’s <code>docs-<version></code> tag, or from its release tag if it
|
|
4675
|
+
has no <code>docs-</code> tag yet.</li>
|
|
4676
|
+
<li>Revise <code>docs/mkdocs/</code>.</li>
|
|
4677
|
+
<li>Deploy without changing <code>latest</code>, for example <code>rake docs:deploy:release[1.1.0]</code>.</li>
|
|
4678
|
+
<li>Point the annotated <code>docs-<version></code> tag at the deployed commit, with a message
|
|
4679
|
+
naming what was deployed. <code>docs-1.1.0</code> is an example.</li>
|
|
4680
|
+
</ol>
|
|
4681
|
+
<p>The branch need not merge anywhere. The tag is the record of what the published
|
|
4682
|
+
documentation was built from. Only repository administrators can create, move, or
|
|
4683
|
+
delete <code>docs-</code> tags.</p>
|
|
4633
4684
|
<p><br/><br/></p>
|
|
4634
4685
|
|
|
4635
4686
|
|
|
@@ -4698,10 +4749,10 @@ workflow guide.</p>
|
|
|
4698
4749
|
|
|
4699
4750
|
|
|
4700
4751
|
|
|
4701
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.
|
|
4752
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4702
4753
|
|
|
4703
4754
|
|
|
4704
|
-
<script src="../assets/javascripts/bundle.
|
|
4755
|
+
<script src="../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
4705
4756
|
|
|
4706
4757
|
|
|
4707
4758
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.57a0d79d.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
<link rel="stylesheet" href="../assets/stylesheets/palette.
|
|
35
|
+
<link rel="stylesheet" href="../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -89,30 +89,16 @@
|
|
|
89
89
|
</div>
|
|
90
90
|
<div data-md-component="announce">
|
|
91
91
|
|
|
92
|
-
<aside class="md-banner">
|
|
93
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</aside>
|
|
101
|
-
|
|
102
92
|
</div>
|
|
103
93
|
|
|
104
94
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
105
95
|
|
|
106
96
|
<aside class="md-banner md-banner--warning">
|
|
107
97
|
<div class="md-banner__inner md-grid md-typeset">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
You are not viewing the latest version.
|
|
98
|
+
You are not viewing the latest version.
|
|
111
99
|
<a href="../..">
|
|
112
100
|
<strong>Click here to go to latest.</strong>
|
|
113
101
|
</a>
|
|
114
|
-
|
|
115
|
-
|
|
116
102
|
</div>
|
|
117
103
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
118
104
|
</aside>
|
|
@@ -5202,7 +5188,7 @@ flag must be passed explicitly every time.</p>
|
|
|
5202
5188
|
<p class="admonition-title">Tip</p>
|
|
5203
5189
|
<p>If you'd rather not remember the <code>--prefer-local</code>, add a shell alias,
|
|
5204
5190
|
e.g. in <code>~/.bashrc</code> / <code>~/.zshrc</code>:</p>
|
|
5205
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nb">alias</span><span class="w"> </span>bundle-install-local<span class="o">=</span><span class="s2"
|
|
5191
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nb">alias</span><span class="w"> </span>bundle-install-local<span class="o">=</span><span class="s2">"bundle install --prefer-local"</span>
|
|
5206
5192
|
</code></pre></div>
|
|
5207
5193
|
</div>
|
|
5208
5194
|
<h3 id="checking-your-environment-without-installing-anything">Checking your environment without installing anything</h3>
|
|
@@ -5232,10 +5218,10 @@ statements and conventions are often messy.</p>
|
|
|
5232
5218
|
<p>Each curated entry records three things. The license is an SPDX identifier
|
|
5233
5219
|
or expression. <code>verified_for</code> is the version the license was read against.
|
|
5234
5220
|
<code>source</code> names where it was read.</p>
|
|
5235
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="s1"
|
|
5236
|
-
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span><span class="ss">license</span><span class="p">:</span><span class="w"> </span><span class="s1"
|
|
5237
|
-
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span><span class="ss">verified_for</span><span class="p">:</span><span class="w"> </span><span class="s1"
|
|
5238
|
-
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w"> </span><span class="ss">source</span><span class="p">:</span><span class="w"> </span><span class="s2"
|
|
5221
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="s1">'rake'</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="p">{</span>
|
|
5222
|
+
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span><span class="ss">license</span><span class="p">:</span><span class="w"> </span><span class="s1">'MIT'</span><span class="p">,</span>
|
|
5223
|
+
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span><span class="ss">verified_for</span><span class="p">:</span><span class="w"> </span><span class="s1">'13.2.1'</span><span class="p">,</span>
|
|
5224
|
+
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w"> </span><span class="ss">source</span><span class="p">:</span><span class="w"> </span><span class="s2">"the gem's own gemspec"</span>
|
|
5239
5225
|
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="p">},</span>
|
|
5240
5226
|
</code></pre></div>
|
|
5241
5227
|
<p><code>rake sbom:build</code> refuses to run when the list and the resolved dependencies
|
|
@@ -5366,7 +5352,7 @@ once with the setup task.</p>
|
|
|
5366
5352
|
<p>Then lint the whole project, or only the files your branch changed.</p>
|
|
5367
5353
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span>lint
|
|
5368
5354
|
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span>lint:changed
|
|
5369
|
-
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2"
|
|
5355
|
+
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2">"lint:changed[master]"</span>
|
|
5370
5356
|
</code></pre></div>
|
|
5371
5357
|
<p><code>lint:changed</code> is the faster loop while working on a branch. It compares against
|
|
5372
5358
|
<code>next_version</code> unless you name another branch or revision. Quote the task name so
|
|
@@ -5409,8 +5395,8 @@ once with the setup task.</p>
|
|
|
5409
5395
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span>profile:setup
|
|
5410
5396
|
</code></pre></div>
|
|
5411
5397
|
<p>Then profile any example project against any Ceedling build task.</p>
|
|
5412
|
-
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2"
|
|
5413
|
-
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2"
|
|
5398
|
+
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2">"profile:run[temp_sensor,test:all]"</span>
|
|
5399
|
+
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="w"> </span>><span class="w"> </span>rake<span class="w"> </span><span class="s2">"profile:run[temp_sensor,clobber test:all]"</span>
|
|
5414
5400
|
</code></pre></div>
|
|
5415
5401
|
<p>The first argument names a project under <code>examples/</code>. The choices are
|
|
5416
5402
|
<code>cipher_quest</code>, <code>temp_sensor</code>, and <code>wondrous_forest</code>. The second argument is
|
|
@@ -5663,10 +5649,10 @@ working on.</p>
|
|
|
5663
5649
|
|
|
5664
5650
|
|
|
5665
5651
|
|
|
5666
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.
|
|
5652
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
5667
5653
|
|
|
5668
5654
|
|
|
5669
|
-
<script src="../assets/javascripts/bundle.
|
|
5655
|
+
<script src="../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
5670
5656
|
|
|
5671
5657
|
|
|
5672
5658
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.57a0d79d.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
<link rel="stylesheet" href="../assets/stylesheets/palette.
|
|
35
|
+
<link rel="stylesheet" href="../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -89,30 +89,16 @@
|
|
|
89
89
|
</div>
|
|
90
90
|
<div data-md-component="announce">
|
|
91
91
|
|
|
92
|
-
<aside class="md-banner">
|
|
93
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</aside>
|
|
101
|
-
|
|
102
92
|
</div>
|
|
103
93
|
|
|
104
94
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
105
95
|
|
|
106
96
|
<aside class="md-banner md-banner--warning">
|
|
107
97
|
<div class="md-banner__inner md-grid md-typeset">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
You are not viewing the latest version.
|
|
98
|
+
You are not viewing the latest version.
|
|
111
99
|
<a href="../..">
|
|
112
100
|
<strong>Click here to go to latest.</strong>
|
|
113
101
|
</a>
|
|
114
|
-
|
|
115
|
-
|
|
116
102
|
</div>
|
|
117
103
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
118
104
|
</aside>
|
|
@@ -4597,10 +4583,10 @@ object’s own source changed.</p>
|
|
|
4597
4583
|
|
|
4598
4584
|
|
|
4599
4585
|
|
|
4600
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.
|
|
4586
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4601
4587
|
|
|
4602
4588
|
|
|
4603
|
-
<script src="../assets/javascripts/bundle.
|
|
4589
|
+
<script src="../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
4604
4590
|
|
|
4605
4591
|
|
|
4606
4592
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.57a0d79d.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
<link rel="stylesheet" href="../assets/stylesheets/palette.
|
|
35
|
+
<link rel="stylesheet" href="../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -89,30 +89,16 @@
|
|
|
89
89
|
</div>
|
|
90
90
|
<div data-md-component="announce">
|
|
91
91
|
|
|
92
|
-
<aside class="md-banner">
|
|
93
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</aside>
|
|
101
|
-
|
|
102
92
|
</div>
|
|
103
93
|
|
|
104
94
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
105
95
|
|
|
106
96
|
<aside class="md-banner md-banner--warning">
|
|
107
97
|
<div class="md-banner__inner md-grid md-typeset">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
You are not viewing the latest version.
|
|
98
|
+
You are not viewing the latest version.
|
|
111
99
|
<a href="../..">
|
|
112
100
|
<strong>Click here to go to latest.</strong>
|
|
113
101
|
</a>
|
|
114
|
-
|
|
115
|
-
|
|
116
102
|
</div>
|
|
117
103
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL(".."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
118
104
|
</aside>
|
|
@@ -5902,10 +5888,10 @@ leave anything Ceedling & its accompanying tools generate out of source cont
|
|
|
5902
5888
|
|
|
5903
5889
|
|
|
5904
5890
|
|
|
5905
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.
|
|
5891
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
5906
5892
|
|
|
5907
5893
|
|
|
5908
|
-
<script src="../assets/javascripts/bundle.
|
|
5894
|
+
<script src="../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
5909
5895
|
|
|
5910
5896
|
|
|
5911
5897
|
</body>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
24
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.
|
|
24
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.8.0">
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<link rel="stylesheet" href="../../assets/stylesheets/main.
|
|
32
|
+
<link rel="stylesheet" href="../../assets/stylesheets/main.57a0d79d.min.css">
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
<link rel="stylesheet" href="../../assets/stylesheets/palette.
|
|
35
|
+
<link rel="stylesheet" href="../../assets/stylesheets/palette.fb2fffe2.min.css">
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -89,30 +89,16 @@
|
|
|
89
89
|
</div>
|
|
90
90
|
<div data-md-component="announce">
|
|
91
91
|
|
|
92
|
-
<aside class="md-banner">
|
|
93
|
-
<div class="md-banner__inner md-grid md-typeset">
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
</div>
|
|
99
|
-
|
|
100
|
-
</aside>
|
|
101
|
-
|
|
102
92
|
</div>
|
|
103
93
|
|
|
104
94
|
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
|
|
105
95
|
|
|
106
96
|
<aside class="md-banner md-banner--warning">
|
|
107
97
|
<div class="md-banner__inner md-grid md-typeset">
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
You are not viewing the latest version.
|
|
98
|
+
You are not viewing the latest version.
|
|
111
99
|
<a href="../../..">
|
|
112
100
|
<strong>Click here to go to latest.</strong>
|
|
113
101
|
</a>
|
|
114
|
-
|
|
115
|
-
|
|
116
102
|
</div>
|
|
117
103
|
<script>var el=document.querySelector("[data-md-component=outdated]"),base=new URL("../.."),outdated=__md_get("__outdated",sessionStorage,base);!0===outdated&&el&&(el.hidden=!1)</script>
|
|
118
104
|
</aside>
|
|
@@ -4526,10 +4512,10 @@ with <code>CIPHER_ROT13</code> defined.</p>
|
|
|
4526
4512
|
|
|
4527
4513
|
|
|
4528
4514
|
|
|
4529
|
-
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.
|
|
4515
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.top", "navigation.indexes", "navigation.path", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../../assets/javascripts/workers/search.a7633da7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
|
|
4530
4516
|
|
|
4531
4517
|
|
|
4532
|
-
<script src="../../assets/javascripts/bundle.
|
|
4518
|
+
<script src="../../assets/javascripts/bundle.c21346df.min.js"></script>
|
|
4533
4519
|
|
|
4534
4520
|
|
|
4535
4521
|
</body>
|