summaryrefslogtreecommitdiff
path: root/docs/tutorials/getting_started.rst
diff options
context:
space:
mode:
authorc1570 <[email protected]>2025-09-25 00:20:45 +0200
committerc1570 <[email protected]>2025-10-20 21:07:06 +0200
commite7b851d9ac2657e591f772dd3fa326e2d8d00270 (patch)
tree5cc40736eba8e2bf5a36039aa3b70b3f7bb957fe /docs/tutorials/getting_started.rst
parente4ff88f3640458f820838efd047a3831333446d8 (diff)
Naming conventions, buffer handling
Diffstat (limited to 'docs/tutorials/getting_started.rst')
-rw-r--r--docs/tutorials/getting_started.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst
index 7853a9cc0..432b0b682 100644
--- a/docs/tutorials/getting_started.rst
+++ b/docs/tutorials/getting_started.rst
@@ -19,6 +19,9 @@ To incorporate TinyUSB into your project:
* Implement all enabled classes' callbacks.
* If you don't use any RTOS at all, you need to continuously and/or periodically call the ``tud_task()``/``tuh_task()`` functions. All of the callbacks and functionality are handled and invoked within the call of that task runner.
+.. note::
+ TinyUSB uses consistent naming prefixes: ``tud_`` for device stack functions and ``tuh_`` for host stack functions. See the :doc:`../reference/glossary` for more details.
+
.. code-block:: c
int main(void) {