-
Notifications
You must be signed in to change notification settings - Fork 38
The last CTL patch :) #1524
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
The last CTL patch :) #1524
Conversation
629b379
to
2706166
Compare
Split between initialize and post-initialize function is necessary for properly handling CTL defaults.
There was a problem hiding this 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" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
examples/ctl/ctl_example.c
Outdated
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
examples/README.md
Outdated
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to be loaded
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
examples/README.md
Outdated
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:: |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 | |||
|
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/config/examples.rst
Outdated
@@ -147,6 +147,35 @@ in the UMF repository. | |||
|
|||
TODO | |||
|
|||
CTL statistics example |
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 | |||
============================================================================== | |||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
================ | ||
Introduction | ||
================ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pls mention experimental API
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
defaults changes global state, so using forks will isolate tests
No description provided.