From 1f2336394b3fa14a587e45daaed8d37f6e48a57b Mon Sep 17 00:00:00 2001 From: Michael Ilyin Date: Mon, 14 Oct 2024 11:33:34 +0200 Subject: [PATCH 1/3] prefix doc update --- docs/concepts.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/concepts.rst b/docs/concepts.rst index a217e7b69..239beb1d5 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -149,10 +149,15 @@ Types named `z_xxx_t` are copyable, and can be passed by value. Some of them are Name Prefixes `z_`, `zc_`, `ze_` ================================ -Most functions and types in the C API use the `z_` prefix, which applies to the common zenoh C API -(currently Rust-based zenoh-c and pure C zenoh-pico). - -The `zc_` prefix is specific to zenoh-c. zenoh-pico uses the `zp_` prefix for the same purpose. - -The `ze_` prefix identifies functions and types from the `zenoh-ext` Rust library that are not -part of the core Zenoh API and therefore are placed in a separate namespace. \ No newline at end of file +Most functions and types in the C API use the `z_` prefix, which applies to the core Zenoh API. +These functions and types are guaranteed to be available in all Zenoh implementations on C +(currently, Rust-based zenoh-c and pure C zenoh-pico). + +The `ze_` prefix is used for the API that is not part of the core zenoh API. There is no guarantee that +these functions and types are available everywhere. However, when they are provided, they should +have the same prototype and behavior across all implementations. Typically, these are functions and types +provided by the `zenoh-ext` Rust library for zenoh-c and are not available in zenoh-pico. However, the data +serialization API is implemented in zenoh-pico with the same `ze_` prefix. + +The `zc_` prefix is specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose. Usually, +these functions are specific to a particular implementation. \ No newline at end of file From 2ae9323dfbac19f657fc89cdb8c30248181016a8 Mon Sep 17 00:00:00 2001 From: Michael Ilyin Date: Mon, 14 Oct 2024 12:50:13 +0200 Subject: [PATCH 2/3] exchanged ze and zc/p --- docs/concepts.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/concepts.rst b/docs/concepts.rst index f25266158..48e2cb7aa 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -158,12 +158,12 @@ Most functions and types in the C API use the `z_` prefix, which applies to the These functions and types are guaranteed to be available in all Zenoh implementations on C (currently, Rust-based zenoh-c and pure C zenoh-pico). +The `zc_` prefix identifies API specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose. +E.g. zenoh-c and zenoh-pico have different approaches to configuration and therefore each have it's own set +of `zc_config_...` and `zp_config_...` functions. + The `ze_` prefix is used for the API that is not part of the core zenoh API. There is no guarantee that these functions and types are available everywhere. However, when they are provided, they should have the same prototype and behavior across all implementations. Typically, these are functions and types provided by the `zenoh-ext` Rust library for zenoh-c and are not available in zenoh-pico. However, the data -serialization API is implemented in zenoh-pico with the same `ze_` prefix. - -The `zc_` prefix identifies API specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose. -E.g. zenoh-c and zenoh-pico have different approaches to configuration and therefore each have it's own set -of `zc_config_...` and `zp_config_...` functions. +serialization API is implemented in zenoh-pico with the same `ze_` prefix. \ No newline at end of file From 269e70b01e728edd278c565287526fe6af1bbe9a Mon Sep 17 00:00:00 2001 From: Michael Ilyin Date: Mon, 14 Oct 2024 13:35:08 +0200 Subject: [PATCH 3/3] minor corrections --- docs/concepts.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/concepts.rst b/docs/concepts.rst index 48e2cb7aa..022f81c03 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -159,11 +159,11 @@ These functions and types are guaranteed to be available in all Zenoh implementa (currently, Rust-based zenoh-c and pure C zenoh-pico). The `zc_` prefix identifies API specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose. -E.g. zenoh-c and zenoh-pico have different approaches to configuration and therefore each have it's own set +E.g. zenoh-c and zenoh-pico have different approaches to configuration and therefore each have their own set of `zc_config_...` and `zp_config_...` functions. The `ze_` prefix is used for the API that is not part of the core zenoh API. There is no guarantee that -these functions and types are available everywhere. However, when they are provided, they should -have the same prototype and behavior across all implementations. Typically, these are functions and types -provided by the `zenoh-ext` Rust library for zenoh-c and are not available in zenoh-pico. However, the data -serialization API is implemented in zenoh-pico with the same `ze_` prefix. \ No newline at end of file +these functions and types are available for both implementations. However, when they are provided for both, they should +have the same prototype and behavior. Typically, these are functions and types provided by the `zenoh-ext` Rust library +for zenoh-c and are not available in zenoh-pico. However, the data serialization API is implemented in zenoh-pico with +the same `ze_` prefix. \ No newline at end of file