Skip to content

Commit

Permalink
deploy: 5166025
Browse files Browse the repository at this point in the history
  • Loading branch information
Risto97 committed Dec 17, 2024
1 parent 55c7eaa commit bcfccff
Show file tree
Hide file tree
Showing 28 changed files with 217 additions and 7 deletions.
2 changes: 2 additions & 0 deletions api_html/_sources/hwip.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ cmake.hwip
files are later used to create the list of files to be compiled (e.g., by a simulator) by a tool to
execute its tasks. The source files are passed as a list after the parameters and keywords.

Relative file paths are accepted and will be converted to absolute, relative to ${CMAKE_CURRENT_SOURCE_DIR}

:param IP_LIB: The target IP library.
:type IP_LIB: string
:param TYPE: The type of source file(s).
Expand Down
20 changes: 20 additions & 0 deletions api_html/_sources/utils/file_paths.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@

######################
cmake.utils/file_paths
######################

.. module:: cmake.utils/file_paths


.. function:: convert_paths_to_absolute(OUTPUT_LIST)

This function converts relative paths to absolute paths relative to ${CMAKE_CURRENT_SOURCE_DIR}
It replicates the behaviour of target_sources() CMake Function

:param OUTPUT_LIST: The variable to store the output file list
:type OUTPUT_LIST: string
:param ARGN: list of files to convert
:type ARGN: path



1 change: 1 addition & 0 deletions api_html/_sources/utils/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ cmake.utils
add_subdirs
alias_dereference
colours
file_paths
find_python
get_all_targets
graphviz
Expand Down
15 changes: 13 additions & 2 deletions api_html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -211,15 +211,15 @@ <h2 id="C">C</h2>
<li><a href="tmake/tmake.html#module-cmake.tmake-tmake">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
cmake.utils/add_subdirs

<ul>
<li><a href="utils/add_subdirs.html#module-cmake.utils-add_subdirs">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
cmake.utils/alias_dereference

Expand All @@ -246,6 +246,13 @@ <h2 id="C">C</h2>

<ul>
<li><a href="utils/copy_rtl_files/vhier.html#module-cmake.utils-copy_rtl_files-vhier">module</a>
</li>
</ul></li>
<li>
cmake.utils/file_paths

<ul>
<li><a href="utils/file_paths.html#module-cmake.utils-file_paths">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -319,6 +326,8 @@ <h2 id="C">C</h2>
</li>
</ul></li>
<li><a href="utils/socmake_graph.html#cmake.utils-socmake_graph.compare_lists">compare_lists() (in module cmake.utils/socmake_graph)</a>
</li>
<li><a href="utils/file_paths.html#cmake.utils-file_paths.convert_paths_to_absolute">convert_paths_to_absolute() (in module cmake.utils/file_paths)</a>
</li>
<li><a href="utils/copy_rtl_files/copy_rtl_files.html#cmake.utils-copy_rtl_files-copy_rtl_files.copy_rtl_files">copy_rtl_files() (in module cmake.utils/copy_rtl_files/copy_rtl_files)</a>
</li>
Expand Down Expand Up @@ -453,6 +462,8 @@ <h2 id="M">M</h2>
<li><a href="utils/copy_rtl_files/copy_rtl_files.html#module-cmake.utils-copy_rtl_files-copy_rtl_files">cmake.utils/copy_rtl_files/copy_rtl_files</a>
</li>
<li><a href="utils/copy_rtl_files/vhier.html#module-cmake.utils-copy_rtl_files-vhier">cmake.utils/copy_rtl_files/vhier</a>
</li>
<li><a href="utils/file_paths.html#module-cmake.utils-file_paths">cmake.utils/file_paths</a>
</li>
<li><a href="utils/find_python.html#module-cmake.utils-find_python">cmake.utils/find_python</a>
</li>
Expand Down
1 change: 1 addition & 0 deletions api_html/hwip.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@
existing list. Ne source files can also be prepended with the optional keyword PREPEND. The source
files are later used to create the list of files to be compiled (e.g., by a simulator) by a tool to
execute its tasks. The source files are passed as a list after the parameters and keywords.</p>
<p>Relative file paths are accepted and will be converted to absolute, relative to ${CMAKE_CURRENT_SOURCE_DIR}</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
Expand Down
1 change: 1 addition & 0 deletions api_html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ <h1>cmake<a class="headerlink" href="#cmake" title="Link to this heading">¶</a>
<li class="toctree-l2"><a class="reference internal" href="utils/add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
Binary file modified api_html/objects.inv
Binary file not shown.
5 changes: 5 additions & 0 deletions api_html/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,11 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="utils/copy_rtl_files/vhier.html#module-cmake.utils-copy_rtl_files-vhier"><code class="xref">cmake.utils/copy_rtl_files/vhier</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="utils/file_paths.html#module-cmake.utils-file_paths"><code class="xref">cmake.utils/file_paths</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand Down
2 changes: 1 addition & 1 deletion api_html/searchindex.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions api_html/utils/add_subdirs.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ <h3>Navigation</h3>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
1 change: 1 addition & 0 deletions api_html/utils/alias_dereference.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
5 changes: 3 additions & 2 deletions api_html/utils/colours.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="cmake.utils/find_python" href="find_python.html" />
<link rel="next" title="cmake.utils/file_paths" href="file_paths.html" />
<link rel="prev" title="cmake.utils/alias_dereference" href="alias_dereference.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
Expand Down Expand Up @@ -69,6 +69,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz.html">cmake.utils/graphviz</a></li>
Expand All @@ -90,7 +91,7 @@ <h3>Related Topics</h3>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">cmake.utils</a><ul>
<li>Previous: <a href="alias_dereference.html" title="previous chapter">cmake.utils/alias_dereference</a></li>
<li>Next: <a href="find_python.html" title="next chapter">cmake.utils/find_python</a></li>
<li>Next: <a href="file_paths.html" title="next chapter">cmake.utils/file_paths</a></li>
</ul></li>
</ul></li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions api_html/utils/copy_rtl_files/copy_rtl_files.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="../add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="../file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="../find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
1 change: 1 addition & 0 deletions api_html/utils/copy_rtl_files/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="../add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="../file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="../find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
1 change: 1 addition & 0 deletions api_html/utils/copy_rtl_files/vhier.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="../add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="../colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="../file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="../find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="../get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../graphviz.html">cmake.utils/graphviz</a></li>
Expand Down
147 changes: 147 additions & 0 deletions api_html/utils/file_paths.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!DOCTYPE html>

<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>cmake.utils/file_paths &#8212; SoCMake 0.1.20 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
<script src="../_static/documentation_options.js?v=17aaaefc"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="cmake.utils/find_python" href="find_python.html" />
<link rel="prev" title="cmake.utils/colours" href="colours.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />





</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<section id="module-cmake.utils-file_paths">
<span id="cmake-utils-file-paths"></span><h1>cmake.utils/file_paths<a class="headerlink" href="#module-cmake.utils-file_paths" title="Link to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="cmake.utils-file_paths.convert_paths_to_absolute">
<span class="sig-prename descclassname"><span class="pre">cmake.utils/file_paths.</span></span><span class="sig-name descname"><span class="pre">convert_paths_to_absolute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">OUTPUT_LIST</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cmake.utils-file_paths.convert_paths_to_absolute" title="Link to this definition"></a></dt>
<dd><p>This function converts relative paths to absolute paths relative to ${CMAKE_CURRENT_SOURCE_DIR}
It replicates the behaviour of target_sources() CMake Function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>OUTPUT_LIST</strong> (<em>string</em>) – The variable to store the output file list</p></li>
<li><p><strong>ARGN</strong> (<em>path</em>) – list of files to convert</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</section>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">SoCMake</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../firmware/index.html">cmake.firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../peakrdl/index.html">cmake.peakrdl</a></li>
<li class="toctree-l1"><a class="reference internal" href="../synth/index.html">cmake.synth</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tmake/index.html">cmake.tmake</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">cmake.utils</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="copy_rtl_files/index.html">cmake.utils/copy_rtl_files</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz/index.html">cmake.utils/graphviz</a></li>
<li class="toctree-l2"><a class="reference internal" href="add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cmake.utils/file_paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="find_python.html">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz.html">cmake.utils/graphviz</a></li>
<li class="toctree-l2"><a class="reference internal" href="option.html">cmake.utils/option</a></li>
<li class="toctree-l2"><a class="reference internal" href="print_help.html">cmake.utils/print_help</a></li>
<li class="toctree-l2"><a class="reference internal" href="print_list.html">cmake.utils/print_list</a></li>
<li class="toctree-l2"><a class="reference internal" href="safe_get_target_property.html">cmake.utils/safe_get_target_property</a></li>
<li class="toctree-l2"><a class="reference internal" href="socmake_graph.html">cmake.utils/socmake_graph</a></li>
<li class="toctree-l2"><a class="reference internal" href="subdirectory_search.html">cmake.utils/subdirectory_search</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../verible/index.html">cmake.verible</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hwip.html">cmake.hwip</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">cmake.utils</a><ul>
<li>Previous: <a href="colours.html" title="previous chapter">cmake.utils/colours</a></li>
<li>Next: <a href="find_python.html" title="next chapter">cmake.utils/find_python</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2024, CERN.

|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.4.7</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="../_sources/utils/file_paths.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
5 changes: 3 additions & 2 deletions api_html/utils/find_python.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="cmake.utils/get_all_targets" href="get_all_targets.html" />
<link rel="prev" title="cmake.utils/colours" href="colours.html" />
<link rel="prev" title="cmake.utils/file_paths" href="file_paths.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />

Expand Down Expand Up @@ -73,6 +73,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="add_subdirs.html">cmake.utils/add_subdirs</a></li>
<li class="toctree-l2"><a class="reference internal" href="alias_dereference.html">cmake.utils/alias_dereference</a></li>
<li class="toctree-l2"><a class="reference internal" href="colours.html">cmake.utils/colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_paths.html">cmake.utils/file_paths</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cmake.utils/find_python</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_all_targets.html">cmake.utils/get_all_targets</a></li>
<li class="toctree-l2"><a class="reference internal" href="graphviz.html">cmake.utils/graphviz</a></li>
Expand All @@ -93,7 +94,7 @@ <h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">cmake.utils</a><ul>
<li>Previous: <a href="colours.html" title="previous chapter">cmake.utils/colours</a></li>
<li>Previous: <a href="file_paths.html" title="previous chapter">cmake.utils/file_paths</a></li>
<li>Next: <a href="get_all_targets.html" title="next chapter">cmake.utils/get_all_targets</a></li>
</ul></li>
</ul></li>
Expand Down
Loading

0 comments on commit bcfccff

Please sign in to comment.