Update docs #47
Merged
Update docs #47
Conversation
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
mickel8
commented
Aug 3, 2020
pages/creating_unifex_natives.md
Outdated
Comment on lines
78
to
84
| ```elixir | ||
| module Example | ||
|
|
||
| interface [NIF, CNode] | ||
|
|
||
| spec foo() :: {:ok :: label, answer :: int} | ||
| ``` |
There was a problem hiding this comment.
Not sure if this example is not too simple but on the other hand I linked some more advanced ones.
mickel8
commented
Aug 3, 2020
pages/creating_unifex_natives.md
Outdated
Comment on lines
146
to
149
| 10:56:38.259 [info] Protocol 'inet_tcp': register/listen error: econnrefused | ||
|
|
||
|
|
||
| 10:56:38.259 [info] Trying to start epmd... |
There was a problem hiding this comment.
The first message is logged by Erlang stdlib when it can't connect to CNode because empd is not started, so there's no way to disable it. The other is logged by Bundlex. It won't happen if epmd is started, so you can remove that from here. See https://erlang.org/doc/man/epmd.html
mickel8
force-pushed
the
update-docs
branch
4 times, most recently
from
e055e2b to
1269399
Compare
mat-hek
requested changes
Aug 5, 2020
README.md
Outdated
| @@ -8,7 +8,7 @@ Unifex is a tool for generating interfaces between native C code and Elixir, tha | |||
| - provides intuitive and conscise tools for defining native interfaces, | |||
| - generates all the boilerplate for you, | |||
| - provides useful abstractions over binaries and state, | |||
| - makes native code independent from `erl_nif` library, so once port-based interface is supported, the same code will be usable either with NIFs or ports. | |||
| - makes native code independent from `erl_nif` library, so the same code is usable either with NIFs or CNodes. | |||
There was a problem hiding this comment.
Suggested change
| - makes native code independent from `erl_nif` library, so the same code is usable either with NIFs or CNodes. | |
| - makes native code independent from [erl_nif](https://erlang.org/doc/man/erl_nif.html) or [ei](https://erlang.org/doc/man/ei.html) library, so the same code is usable either with NIFs or CNodes. |
pages/creating_unifex_natives.md
Outdated
Comment on lines
90
to
94
| More information on how `.spec.exs` files should be created can be found in docs for | ||
| `Unifex.Specs.DSL` module. | ||
| You can also check out our [test_projects](https://github.com/membraneframework/unifex/tree/master/test_projects) | ||
| to see a little more advanced examples or look how we use Unifex in a our repositories | ||
| e.g. in [shmex](https://github.com/membraneframework). |
There was a problem hiding this comment.
It's also stated at the end, I think it's enough to have it there
pages/creating_unifex_natives.md
Outdated
| ## More examples | ||
| You can find more complete projects [here](https://github.com/membraneframework/unifex/tree/master/test_projects). | ||
| Also check out how we use Unifex in our [repositories](https://github.com/membraneframework) e.g. in | ||
| [shmex](https://github.com/membraneframework/shmex) and please refer to `Unifex.Specs.DSL` module's documentation |
There was a problem hiding this comment.
actually we don't use unifex in shmex, because unifex uses shmex :P
pages/creating_unifex_natives.md
Outdated
Comment on lines
3
to
5
| ## Introduction | ||
| In this section we present how to create Unifex Natives. | ||
| We will show it by writing code that will be compiled both as NIF and CNode. |
There was a problem hiding this comment.
Suggested change
| ## Introduction | |
| In this section we present how to create Unifex Natives. | |
| We will show it by writing code that will be compiled both as NIF and CNode. | |
| In this tutorial, you will learn how to use Unifex natives to write native code that can be compiled both as NIF and CNode. |
mat-hek
approved these changes
Aug 6, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #46