Skip to content

Commit a7ca607

Browse files
Merge pull request #128 from gowthamsk-arm/update_readme
Update README to specify prefix feature
2 parents ea134c2 + 6b06122 commit a7ca607

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

psa-crypto-sys/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ makes no difference and there is no way to allow dynamic linking. The
2929
requirements for configuring and building MbedTLS can be found
3030
[on their repository homepage](https://github.com/ARMmbed/mbedtls#tool-versions).
3131

32-
When the crate builds the library, both the `mbedcrypto` library
33-
itself and the `shim` library (which is needed for inline functions)
34-
are renamed by adding a prefix of the form `psa_crypto_X_Y_Z_`. Also
35-
every globally defined symbol in those libraries has that prefix
36-
added. This is to avoid link-time collisions with other crates that
37-
might use the same library, including other versions of this crate.
38-
The renaming of symbols uses the `nm` and `objcopy` commands.
32+
By default, the `mbedcrypto` library itself and the `shim` library (which
33+
is needed for inline functions) will not have not have any prefixes. If
34+
the `prefix` feature is enabled, both the libraries are renamed by
35+
adding a prefix of the form `psa_crypto_X_Y_Z_`. Also every globally
36+
defined symbol in those libraries has that prefix added. This is to
37+
avoid link-time collisions with other crates that might use the same
38+
library, including other versions of this crate. The renaming of
39+
symbols uses the `nm` and `objcopy` commands.
3940

4041
Linking and generating implementation-specific APIs is controlled by the
4142
`operations` feature that is enabled by default. Therefore, if you

0 commit comments

Comments
 (0)