Skip to content

Conversation

lplewa
Copy link
Contributor

@lplewa lplewa commented Sep 17, 2025

No description provided.

@lplewa lplewa changed the title Ctl split The last CTL patch :) Sep 17, 2025
@lplewa lplewa force-pushed the ctl_split branch 11 times, most recently from 629b379 to 2706166 Compare September 18, 2025 14:44
@lplewa lplewa marked this pull request as ready for review September 18, 2025 15:22
@lplewa lplewa requested a review from a team as a code owner September 18, 2025 15:22
Copy link
Contributor

@lukaszstolarczuk lukaszstolarczuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after all, this is super huge PR - I'd split this somehow, if easily done...

@@ -228,10 +236,12 @@ jobs:
env:
UMF_LOG: level:warning;flush:debug;output:stderr;pid:no
run: |
$env:UMF_LOG="level:warning;flush:debug;output:stderr;pid:no"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure if needed - we set this literally 2 lines above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say _example in the name seems redundant and inconsistent with other examples.

// same with the other example's name

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


This example demonstrates how to add CTL support to a custom memory
provider. It sets variables ``a`` and ``b`` through CTL, plus it allows
for the modulus ``m`` loaded from the environment or a configuration file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be loaded

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

for the modulus ``m`` loaded from the environment or a configuration file.
Addition and subtraction operations return results modulo ``m`` and the
result ``c`` can be retrieved using the CTL API. For example, to set the
modulus through an environment variable run::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:: -> : (this is MD file, not rst)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -66,3 +66,14 @@ processes: a producer and a consumer that communicate in the following way
- Producer puts the IPC handle
- Consumer shuts down
- Producer shuts down

## CTL example

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this description is only about one of the examples

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -126,7 +126,7 @@ typedef struct umf_memory_provider_ops_t {
/// \details
/// * Implementations *must* return a literal null-terminated string.
///
/// * Implementations *must* return default pool name when NULL is provided,
/// * Implementations *must* return default provider name when NULL is provided,
/// otherwise the pool's name is returned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since you fix above, fix here as well pool's -> provider's

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -147,6 +147,35 @@ in the UMF repository.

TODO

CTL statistics example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm and here you have the other example explained...? perhaps describe both of them in both places...? (web docs and example's README)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -147,6 +147,35 @@ in the UMF repository.

TODO

CTL statistics example
==============================================================================

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls mentione similarly to above examples - ... rely on experimental APIs that may change in future releases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

================
Introduction
================

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls mention experimental API

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants