summaryrefslogtreecommitdiffstats
path: root/libnetdata/string/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-07-24 09:54:23 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-07-24 09:54:44 +0000
commit836b47cb7e99a977c5a23b059ca1d0b5065d310e (patch)
tree1604da8f482d02effa033c94a84be42bc0c848c3 /libnetdata/string/README.md
parentReleasing debian version 1.44.3-2. (diff)
downloadnetdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.tar.xz
netdata-836b47cb7e99a977c5a23b059ca1d0b5065d310e.zip
Merging upstream version 1.46.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libnetdata/string/README.md')
-rw-r--r--libnetdata/string/README.md25
1 files changed, 0 insertions, 25 deletions
diff --git a/libnetdata/string/README.md b/libnetdata/string/README.md
deleted file mode 100644
index 4fd442507..000000000
--- a/libnetdata/string/README.md
+++ /dev/null
@@ -1,25 +0,0 @@
-<!--
-title: "String"
-custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/string/README.md
-sidebar_label: "String"
-learn_status: "Published"
-learn_topic_type: "Tasks"
-learn_rel_path: "Developers/libnetdata"
--->
-
-# STRING
-
-STRING provides a way to allocate and free text strings, while de-duplicating them.
-
-It can be used similarly to libc string functions:
-
- - `strdup()` and `strdupz()` become `string_strdupz()`.
- - `strlen()` becomes `string_strlen()` (and it does not walkthrough the bytes of the string).
- - `free()` and `freez()` become `string_freez()`.
-
-There is also a special `string_dup()` function that increases the reference counter of a STRING, avoiding the
-index lookup to find it.
-
-Once there is a `STRING *`, the actual `const char *` can be accessed with `string2str()`.
-
-All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.