-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
BuildTheDocs
authored and
BuildTheDocs
committed
Jun 6, 2024
0 parents
commit f536516
Showing
116 changed files
with
30,691 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: bda6c2d6f835236c10467efc30bc01d3 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>About — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation</title> | ||
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/graphviz.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" /> | ||
| <link rel="shortcut icon" href="_static/icon.png"/> | ||
| <!--[if lt IE 9]> | ||
| <script src="_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> | ||
| <script src="_static/jquery.js"></script> | ||
| <script src="_static/underscore.js"></script> | ||
| <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
| <script src="_static/doctools.js"></script> | ||
| <script src="_static/sphinx_highlight.js"></script> | ||
| <script src="_static/js/theme.js"></script> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| <link rel="next" title="Introduction" href="ug/index.html" /> | ||
| <link rel="prev" title="Tools and images" href="ToolsAndImages.html" /> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav"> | ||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search" > | ||
| <a href="index.html"> | ||
| <img src="_static/icon.svg" class="logo" alt="Logo"/> | ||
| </a> | ||
| <div class="version"> | ||
| latest | ||
| </div> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| </div> | ||
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <ul class="current"> | ||
| <li class="toctree-l1"><a class="reference external" href="http://hdl.github.io/containers">Home</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="CollectionsAndArchitectures.html">Collections and architectures</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="ToolsAndImages.html">Tools and images</a></li> | ||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">About</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="#id1">Context</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#hdl-organisation">HDL Organisation</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">User Guide</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="ug/index.html">Introduction</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="ug/FineGrained.html">Fine-grained pulling</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="ug/AllInOne.html">All-in-one images</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="ug/GUI.html">Tools with GUI</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="ug/USBIP.html">USB/IP</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Development</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/Contributing.html">Contributing</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/Graphs.html">Graphs</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/PackageImages.html">Package images</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/Utils.html">Utils</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/CI.html">Continuous Integration (CI)</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="dev/Tasks.html">Tasks</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Appendix</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="References.html">References</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="License.html">Apache License 2.0</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="Doc-License.html">Creative Commons Attribution 4.0 International</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">HDL Containers: Building and deploying container images for open source Electronic Design Automation</a> | ||
| </nav> | ||
|
|
||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
|
|
||
|
|
||
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="index.html" class="icon icon-home"></a> »</li> | ||
| <li>About</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="https://github.com/hdl/containers/blob/main/doc/About.rst" class="fa fa-github"> Edit on GitHub</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
|
|
||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="about"> | ||
| <span id="context"></span><h1>About<a class="headerlink" href="#about" title="Permalink to this heading">¶</a></h1> | ||
| <p>Unai Martinez-Corral [ | ||
| <a class="reference external" href="https://github.com/umarcor">@GitHub</a> | ||
| <a class="reference external" href="https://gitlab.com/umarcor">@GitLab</a> | ||
| <a class="reference external" href="https://twitter.com/unaimarcor">@Twitter</a> | ||
| ] | ||
| and <a class="reference external" href="https://github.com/hdl/containers/graphs/contributors">contributors</a></p> | ||
| <section id="id1"> | ||
| <h2>Context<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h2> | ||
| <p>This project started in early 2017 at GitHub repository <a class="reference external" href="https://github.com/ghdl/ghdl">gh:ghdl/ghdl</a> (which was named tgingold/ghdl back then). | ||
| The main purpose was testing GHDL on multiple GNU/Linux distributions (Debian, Ubuntu and Fedora), since | ||
| <a class="reference external" href="https://travis-ci.org/">Travis CI</a> supported Ubuntu only and Docker. | ||
| For each target platform, two images were used, one for building and another one for testing.</p> | ||
| <p>Later, most of the Docker related sources were split to repository <a class="reference external" href="https://github.com/ghdl/docker">gh:ghdl/docker</a>. | ||
| There, some additional simulation tools were added, such as <a class="reference external" href="http://vunit.github.io/">VUnit</a> and | ||
| <a class="reference external" href="http://gtkwave.sourceforge.net/">GtkWave</a>. | ||
| Images including the <a class="reference external" href="https://github.com/ghdl/ghdl-language-server">ghdl-language-server</a> were also added. | ||
| When experimental synthesis support was added to GHDL in 2019, and since it provides a plugin for <a class="reference external" href="https://github.com/YosysHQ/yosys">Yosys</a>, | ||
| containers including tools for providing a complete open source bitstream generation and formal verification workflow | ||
| were requested and contributed. | ||
| Those were | ||
| <a class="reference external" href="https://github.com/YosysHQ/nextpnr">nextpnr</a>, | ||
| <a class="reference external" href="https://github.com/YosysHQ/icestorm">icestorm</a>, | ||
| <a class="reference external" href="https://github.com/YosysHQ/prjtrellis">prjtrellis</a>, | ||
| <a class="reference external" href="https://github.com/YosysHQ/SymbiYosys">SymbiYosys</a>, | ||
| etc.</p> | ||
| <p>At some point, ghdl/docker had as much content related to non-GHDL tools, as resources related to the organisation. | ||
| In the second half of 2019, sharing the development effort was proposed to maintainers of Yosys (<a class="reference external" href="https://github.com/YosysHQ/yosys/issues/1287">YosysHQ/yosys#1287</a>) | ||
| and LibreCores (<a class="reference external" href="https://github.com/librecores/docker-images/issues/33">librecores/docker-images#33</a>), which went unfortunately | ||
| unnoticed.</p> | ||
| <p>At the same time, <a class="reference external" href="https://f4pga.org">F4PGA</a> aimed at gathering open source projects for providing an integrated open | ||
| source EDA solution. | ||
| However, it did not have official container images and <a class="reference external" href="https://f4pga.org/developers.html">help was wanted</a>. | ||
| This repository was initially created for moving all the tools which were not part of GHDL, from ghdl/docker to | ||
| f4pga/containers. | ||
| However, since F4PGA was (partially still is) focused on Verilog, the scope was widened to include VHDL, and the | ||
| repository was published at <a class="reference external" href="https://github.com/hdl/containers">gh:hdl/containers</a> in 2020.</p> | ||
| <p>In parallel to splitting ghdl/docker form ghdl/ghdl, in early 2019 <a class="reference external" href="https://github.com/dbhi/qus">gh:dbhi/qus</a> (see <a class="reference external" href="https://dbhi.github.io/qus/index.html" title="(in qemu-user-static (qus) and containers vlatest)"><span>qemu-user-static (qus) and containers</span></a>) was created | ||
| as a generalisation of <a class="reference external" href="https://github.com/multiarch/qemu-user-static">gh:multiarch/qemu-user-static</a>. | ||
| <em>qus</em> is used in <a class="reference external" href="https://github.com/dbhi/containers">gh:dbhi/containers</a> to build multi-architecture container images and manifests on Continuous | ||
| Integration (CI) services with amd64 hosts only (say Travis CI or <a class="reference external" href="https://github.com/features/actions">GitHub Actions</a>). | ||
| Currently, hdl/containers uses the same solution to build container images for <em>foreign</em> architectures.</p> | ||
| <p>Until the end of 2020, the scope of hdl/containers was limited to HDL simulation, formal verification and FPGA bitstream | ||
| generation; and container images were distributed through <code class="docutils literal notranslate"><span class="pre">docker.io</span></code> only. | ||
| Since 2021, tools for ASIC development are also provided, and two other registries are used as well: | ||
| <code class="docutils literal notranslate"><span class="pre">gcr.io</span></code> and <code class="docutils literal notranslate"><span class="pre">ghcr.io</span></code>.</p> | ||
| </section> | ||
| <section id="hdl-organisation"> | ||
| <h2>HDL Organisation<a class="headerlink" href="#hdl-organisation" title="Permalink to this heading">¶</a></h2> | ||
| <ul class="simple"> | ||
| <li><p><a class="reference external" href="https://github.com/hdl/packages"><img alt="'hdl/packages GitHub repository'" class="shield" src="https://img.shields.io/badge/hdl-packages-f2f1ef.svg?longCache=true&style=flat-square&logo=GitHub&logoColor=f2f1ef" style="height: 22px;" /></a></p></li> | ||
| <li><p><a class="reference external" href="https://github.com/hdl/awesome"><img alt="'hdl/awesome GitHub repository'" class="shield" src="https://img.shields.io/badge/hdl-awesome-f2f1ef.svg?longCache=true&style=flat-square&logo=GitHub&logoColor=f2f1ef" style="height: 22px;" /></a> <a class="reference external" href="https://hdl.github.io/awesome"><img alt="'hdl.github.io/awesome'" class="shield" src="https://img.shields.io/website?longCache=true&style=flat-square&label=hdl.github.io%2Fawesome&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fhdl.github.io%2Fawesome%2Findex.html" style="height: 22px;" /></a></p></li> | ||
| <li><p><a class="reference external" href="https://github.com/hdl/constraints"><img alt="'hdl/constraints GitHub repository'" class="shield" src="https://img.shields.io/badge/hdl-constraints-f2f1ef.svg?longCache=true&style=flat-square&logo=GitHub&logoColor=f2f1ef" style="height: 22px;" /></a> <a class="reference external" href="https://hdl.github.io/constraints"><img alt="'hdl.github.io/constraints'" class="shield" src="https://img.shields.io/website?longCache=true&style=flat-square&label=hdl.github.io%2Fconstraints&logo=GitHub&logoColor=fff&up_color=blueviolet&up_message=Read%20now%20%E2%9E%9A&url=https%3A%2F%2Fhdl.github.io%2Fconstraints%2Findex.html" style="height: 22px;" /></a></p></li> | ||
| <li><p><a class="reference external" href="https://github.com/hdl/smoke-tests"><img alt="'hdl/smoke-tests GitHub repository'" class="shield" src="https://img.shields.io/badge/hdl-smoke--tests-f2f1ef.svg?longCache=true&style=flat-square&logo=GitHub&logoColor=f2f1ef" style="height: 22px;" /></a></p></li> | ||
| </ul> | ||
| </section> | ||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
| <a href="ToolsAndImages.html" class="btn btn-neutral float-left" title="Tools and images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| <a href="ug/index.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2019-2023, Unai Martinez-Corral and contributors.</p> | ||
| </div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a | ||
| <a href="https://github.com/buildthedocs/sphinx.theme">theme</a> | ||
| provided by <a href="https://buildthedocs.github.io">Build the Docs</a>. | ||
|
|
||
|
|
||
| </footer> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.