write introduction for the Utilities Section docs/3.1

Thu, 06 Feb 2025 20:09:55 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 06 Feb 2025 20:09:55 +0100
branch
docs/3.1
changeset 1166
03bbdf402675
parent 1165
e4e2c43d12c2
child 1167
feab7c1e80d4

write introduction for the Utilities Section

relates to #451

docs/Writerside/topics/streams.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/utils.md file | annotate | diff | comparison | revisions
--- a/docs/Writerside/topics/streams.h.md	Wed Jan 29 23:58:17 2025 +0100
+++ b/docs/Writerside/topics/streams.h.md	Thu Feb 06 20:09:55 2025 +0100
@@ -1,6 +1,7 @@
 # Data Streams
 
 Stream copy functions provide a way to copy all - or a  limited amount of - data from one stream to another.
+
 Since the read/write functions of a [UCX buffer](buffer.h.md) are fully compatible with stream read/write functions,
 you can, for example, easily transfer data from a file or network stream to a UCX buffer or vice versa.
 
--- a/docs/Writerside/topics/utils.md	Wed Jan 29 23:58:17 2025 +0100
+++ b/docs/Writerside/topics/utils.md	Thu Feb 06 20:09:55 2025 +0100
@@ -1,1 +1,14 @@
 # Utilities
+
+Useful functions that are not specifically tied to a certain topic or domain are called Utilities.
+The most useful of which are the predefined [compare functions](compare.h.md) for various primitive types.
+
+The [hash functions](hash_key.h.md) are usually of lesser interest unless you are using [hash maps](hash_map.h.md),
+but they can be also used independently of the hash map context.
+
+When you are working with [data streams](streams.h.md), e.g. `FILE` streams
+or any other stream (or buffer) API that uses an `fwrite`-compatible interface,
+you will find the stream copy function quite useful.
+
+And last, but not least, if you are interested in unit testing, but don't know which testing framework to use:
+search no more, because we have got your back with [UCX Test](test.h.md).

mercurial