Skip to content

Remove incorrect community example links #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions static/1.25.1/api/jpm/cc.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,35 +109,35 @@ <h2 id="Index-8">Index
</h2>
<p><a href="#cc/archive-c">cc/archive-c</a> <a href="#cc/compile-c">cc/compile-c</a> <a href="#cc/create-buffer-c">cc/create-buffer-c</a> <a href="#cc/create-buffer-c-impl">cc/create-buffer-c-impl</a> <a href="#cc/create-executable">cc/create-executable</a> <a href="#cc/embed-name">cc/embed-name</a> <a href="#cc/entry-name">cc/entry-name</a> <a href="#cc/entry-replace">cc/entry-replace</a> <a href="#cc/link-c">cc/link-c</a> <a href="#cc/make-bin-source">cc/make-bin-source</a> <a href="#cc/make-define">cc/make-define</a> <a href="#cc/make-defines">cc/make-defines</a> <a href="#cc/modpath-to-meta">cc/modpath-to-meta</a> <a href="#cc/modpath-to-static">cc/modpath-to-static</a> <a href="#cc/out-path">cc/out-path</a> </p><hr><div class="binding"><span id="cc/archive-c" class="binding-sym">cc/archive-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L121">source</a></span> <pre class="binding-text">(archive-c opts target &amp; objects)

Link object files together to make a static library.</pre><a href="https://janetdocs.com/cc/archive-c">Community Examples</a></div><hr><div class="binding"><span id="cc/compile-c" class="binding-sym">cc/compile-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L83">source</a></span> <pre class="binding-text">(compile-c compiler opts src dest &amp;opt static?)
Link object files together to make a static library.</pre></div><hr><div class="binding"><span id="cc/compile-c" class="binding-sym">cc/compile-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L83">source</a></span> <pre class="binding-text">(compile-c compiler opts src dest &amp;opt static?)

Compile a C file into an object file.</pre><a href="https://janetdocs.com/cc/compile-c">Community Examples</a></div><hr><div class="binding"><span id="cc/create-buffer-c" class="binding-sym">cc/create-buffer-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L150">source</a></span> <pre class="binding-text">(create-buffer-c source dest name)
Compile a C file into an object file.</pre></div><hr><div class="binding"><span id="cc/create-buffer-c" class="binding-sym">cc/create-buffer-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L150">source</a></span> <pre class="binding-text">(create-buffer-c source dest name)

Inline raw byte file as a c file.</pre><a href="https://janetdocs.com/cc/create-buffer-c">Community Examples</a></div><hr><div class="binding"><span id="cc/create-buffer-c-impl" class="binding-sym">cc/create-buffer-c-impl</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L136">source</a></span> <pre class="binding-text">(create-buffer-c-impl bytes dest name)
Inline raw byte file as a c file.</pre></div><hr><div class="binding"><span id="cc/create-buffer-c-impl" class="binding-sym">cc/create-buffer-c-impl</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L136">source</a></span> <pre class="binding-text">(create-buffer-c-impl bytes dest name)

</pre><a href="https://janetdocs.com/cc/create-buffer-c-impl">Community Examples</a></div><hr><div class="binding"><span id="cc/create-executable" class="binding-sym">cc/create-executable</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L271">source</a></span> <pre class="binding-text">(create-executable opts source dest no-core)
</pre></div><hr><div class="binding"><span id="cc/create-executable" class="binding-sym">cc/create-executable</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L271">source</a></span> <pre class="binding-text">(create-executable opts source dest no-core)

Links an image with libjanet.a (or .lib) to produce an executable. Also will try to link native modules into the final executable as well.</pre><a href="https://janetdocs.com/cc/create-executable">Community Examples</a></div><hr><div class="binding"><span id="cc/embed-name" class="binding-sym">cc/embed-name</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L18">source</a></span> <pre class="binding-text">(embed-name path)
Links an image with libjanet.a (or .lib) to produce an executable. Also will try to link native modules into the final executable as well.</pre></div><hr><div class="binding"><span id="cc/embed-name" class="binding-sym">cc/embed-name</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L18">source</a></span> <pre class="binding-text">(embed-name path)

Rename a janet symbol for embedding.</pre><a href="https://janetdocs.com/cc/embed-name">Community Examples</a></div><hr><div class="binding"><span id="cc/entry-name" class="binding-sym">cc/entry-name</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L78">source</a></span> <pre class="binding-text">(entry-name name)
Rename a janet symbol for embedding.</pre></div><hr><div class="binding"><span id="cc/entry-name" class="binding-sym">cc/entry-name</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L78">source</a></span> <pre class="binding-text">(entry-name name)

Name of symbol that enters static compilation of a module.</pre><a href="https://janetdocs.com/cc/entry-name">Community Examples</a></div><hr><div class="binding"><span id="cc/entry-replace" class="binding-sym">cc/entry-replace</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L13">source</a></span> <pre class="binding-text">(entry-replace name)
Name of symbol that enters static compilation of a module.</pre></div><hr><div class="binding"><span id="cc/entry-replace" class="binding-sym">cc/entry-replace</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L13">source</a></span> <pre class="binding-text">(entry-replace name)

Escape special characters in the entry-name</pre><a href="https://janetdocs.com/cc/entry-replace">Community Examples</a></div><hr><div class="binding"><span id="cc/link-c" class="binding-sym">cc/link-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L101">source</a></span> <pre class="binding-text">(link-c has-cpp opts target &amp; objects)
Escape special characters in the entry-name</pre></div><hr><div class="binding"><span id="cc/link-c" class="binding-sym">cc/link-c</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L101">source</a></span> <pre class="binding-text">(link-c has-cpp opts target &amp; objects)

Link C or C++ object files together to make a native module.</pre><a href="https://janetdocs.com/cc/link-c">Community Examples</a></div><hr><div class="binding"><span id="cc/make-bin-source" class="binding-sym">cc/make-bin-source</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L170">source</a></span> <pre class="binding-text">(make-bin-source declarations lookup-into-invocations no-core)
Link C or C++ object files together to make a native module.</pre></div><hr><div class="binding"><span id="cc/make-bin-source" class="binding-sym">cc/make-bin-source</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L170">source</a></span> <pre class="binding-text">(make-bin-source declarations lookup-into-invocations no-core)

</pre><a href="https://janetdocs.com/cc/make-bin-source">Community Examples</a></div><hr><div class="binding"><span id="cc/make-define" class="binding-sym">cc/make-define</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L35">source</a></span> <pre class="binding-text">(make-define define value)
</pre></div><hr><div class="binding"><span id="cc/make-define" class="binding-sym">cc/make-define</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L35">source</a></span> <pre class="binding-text">(make-define define value)

Generate strings for adding custom defines to the compiler.</pre><a href="https://janetdocs.com/cc/make-define">Community Examples</a></div><hr><div class="binding"><span id="cc/make-defines" class="binding-sym">cc/make-defines</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L42">source</a></span> <pre class="binding-text">(make-defines defines)
Generate strings for adding custom defines to the compiler.</pre></div><hr><div class="binding"><span id="cc/make-defines" class="binding-sym">cc/make-defines</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L42">source</a></span> <pre class="binding-text">(make-defines defines)

Generate many defines. Takes a dictionary of defines. If a value is true, generates -DNAME (/DNAME on windows), otherwise -DNAME=value.</pre><a href="https://janetdocs.com/cc/make-defines">Community Examples</a></div><hr><div class="binding"><span id="cc/modpath-to-meta" class="binding-sym">cc/modpath-to-meta</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L160">source</a></span> <pre class="binding-text">(modpath-to-meta path)
Generate many defines. Takes a dictionary of defines. If a value is true, generates -DNAME (/DNAME on windows), otherwise -DNAME=value.</pre></div><hr><div class="binding"><span id="cc/modpath-to-meta" class="binding-sym">cc/modpath-to-meta</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L160">source</a></span> <pre class="binding-text">(modpath-to-meta path)

Get the meta file path (.meta.janet) corresponding to a native module path (.so).</pre><a href="https://janetdocs.com/cc/modpath-to-meta">Community Examples</a></div><hr><div class="binding"><span id="cc/modpath-to-static" class="binding-sym">cc/modpath-to-static</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L165">source</a></span> <pre class="binding-text">(modpath-to-static path)
Get the meta file path (.meta.janet) corresponding to a native module path (.so).</pre></div><hr><div class="binding"><span id="cc/modpath-to-static" class="binding-sym">cc/modpath-to-static</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L165">source</a></span> <pre class="binding-text">(modpath-to-static path)

Get the static library (.a) path corresponding to a native module path (.so).</pre><a href="https://janetdocs.com/cc/modpath-to-static">Community Examples</a></div><hr><div class="binding"><span id="cc/out-path" class="binding-sym">cc/out-path</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L26">source</a></span> <pre class="binding-text">(out-path path from-ext to-ext)
Get the static library (.a) path corresponding to a native module path (.so).</pre></div><hr><div class="binding"><span id="cc/out-path" class="binding-sym">cc/out-path</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cc.janet#L26">source</a></span> <pre class="binding-text">(out-path path from-ext to-ext)

Take a source file path and convert it to an output path.</pre><a href="https://janetdocs.com/cc/out-path">Community Examples</a></div>
Take a source file path and convert it to an output path.</pre></div>
<div class="prevnext-bar">
<span class="prev"><a href="rules.html"><span class="prevnext-text">Build Rules</span></a></span>
<span class="next"><a href="cgen.html"><span class="prevnext-text">C Source Generation</span></a></span>
Expand Down
8 changes: 4 additions & 4 deletions static/1.25.1/api/jpm/cgen.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,13 @@ <h2 id="Index-9">Index
</h2>
<p><a href="#cgen/add-loader">cgen/add-loader</a> <a href="#cgen/ir">cgen/ir</a> <a href="#cgen/mangle">cgen/mangle</a> <a href="#cgen/print-ir">cgen/print-ir</a> </p><hr><div class="binding"><span id="cgen/add-loader" class="binding-sym">cgen/add-loader</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L462">source</a></span> <pre class="binding-text">(add-loader)

Adds the custom template loader to Janet's module/loaders and update module/paths.</pre><a href="https://janetdocs.com/cgen/add-loader">Community Examples</a></div><hr><div class="binding"><span id="cgen/ir" class="binding-sym">cgen/ir</span> <span class="binding-type">macro</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L438">source</a></span> <pre class="binding-text">(ir &amp; body)
Adds the custom template loader to Janet's module/loaders and update module/paths.</pre></div><hr><div class="binding"><span id="cgen/ir" class="binding-sym">cgen/ir</span> <span class="binding-type">macro</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L438">source</a></span> <pre class="binding-text">(ir &amp; body)

Macro that automatically quotes the body provided and calls (print-ir ...) on the body.</pre><a href="https://janetdocs.com/cgen/ir">Community Examples</a></div><hr><div class="binding"><span id="cgen/mangle" class="binding-sym">cgen/mangle</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L25">source</a></span> <pre class="binding-text">(mangle token)
Macro that automatically quotes the body provided and calls (print-ir ...) on the body.</pre></div><hr><div class="binding"><span id="cgen/mangle" class="binding-sym">cgen/mangle</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L25">source</a></span> <pre class="binding-text">(mangle token)

Convert any sequence of bytes to a valid C identifier in a way that is unlikely to collide. `print-ir` will not mangle symbols for you.</pre><a href="https://janetdocs.com/cgen/mangle">Community Examples</a></div><hr><div class="binding"><span id="cgen/print-ir" class="binding-sym">cgen/print-ir</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L31">source</a></span> <pre class="binding-text">(print-ir ir)
Convert any sequence of bytes to a valid C identifier in a way that is unlikely to collide. `print-ir` will not mangle symbols for you.</pre></div><hr><div class="binding"><span id="cgen/print-ir" class="binding-sym">cgen/print-ir</span> <span class="binding-type">function</span> <span class="binding-type"><a href="https://github.com/janet-lang/janet/blob/894cd0e//home/calvin/code/janet-lang.org/build/jpm/cgen.janet#L31">source</a></span> <pre class="binding-text">(print-ir ir)

Compile the CGEN IR to C and print it to (dyn :out).</pre><a href="https://janetdocs.com/cgen/print-ir">Community Examples</a></div>
Compile the CGEN IR to C and print it to (dyn :out).</pre></div>
<div class="prevnext-bar">
<span class="prev"><a href="cc.html"><span class="prevnext-text">C Compiler</span></a></span>
<span class="next"><a href="cli.html"><span class="prevnext-text">Command Line Interface</span></a></span>
Expand Down
Loading