aboutsummaryrefslogtreecommitdiff
path: root/string/README.contributors
diff options
context:
space:
mode:
authorElliott Hughes <enh@google.com>2023-01-25 20:51:23 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-01-25 20:51:23 +0000
commit8783f524beaad825ac1bddeb93cef35b5f793513 (patch)
tree945eb1832687ad5eb97c433013617dbe107718e5 /string/README.contributors
parent0bc581b0e4f509c96bffa7af329087ae2b4bfb97 (diff)
parent62662f115a17a5548402fcd02f3b7e1b9b38e087 (diff)
downloadarm-optimized-routines-8783f524beaad825ac1bddeb93cef35b5f793513.tar.gz
Upgrade ARM-software/optimized-routines to v23.01 am: 62662f115a
Original change: https://android-review.googlesource.com/c/platform/external/arm-optimized-routines/+/2402215 Change-Id: Ic29e1a6f8a0485f6317699bfda38fb79e7022ee1 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'string/README.contributors')
-rw-r--r--string/README.contributors30
1 files changed, 30 insertions, 0 deletions
diff --git a/string/README.contributors b/string/README.contributors
new file mode 100644
index 0000000..0b4a51b
--- /dev/null
+++ b/string/README.contributors
@@ -0,0 +1,30 @@
+STYLE REQUIREMENTS
+==================
+
+1. Most code in this sub-directory is expected to be upstreamed into glibc so
+ the GNU Coding Standard and glibc specific conventions should be followed
+ to ease upstreaming.
+
+2. ABI and symbols: the code should be written so it is suitable for inclusion
+ into a libc with minimal changes. This e.g. means that internal symbols
+ should be hidden and in the implementation reserved namespace according to
+ ISO C and POSIX rules. If possible the built shared libraries and static
+ library archives should be usable to override libc symbols at link time (or
+ at runtime via LD_PRELOAD). This requires the symbols to follow the glibc ABI
+ (other than symbol versioning), this cannot be done reliably for static
+ linking so this is a best effort requirement.
+
+3. API: include headers should be suitable for benchmarking and testing code
+ and should not conflict with libc headers.
+
+
+CONTRIBUTION GUIDELINES FOR string SUB-DIRECTORY
+================================================
+1. Code:
+ - The assumptions of the code must be clearly documented.
+
+ - Assembly style should be consistent across different implementations.
+
+
+2. Performance:
+ - Benchmarking is needed on several microarchitectures.