xref: /freebsd/contrib/arm-optimized-routines/string/README.contributors (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1STYLE REQUIREMENTS
2==================
3
41. Most code in this sub-directory is expected to be upstreamed into glibc so
5   the GNU Coding Standard and glibc specific conventions should be followed
6   to ease upstreaming.
7
82. ABI and symbols: the code should be written so it is suitable for inclusion
9   into a libc with minimal changes. This e.g. means that internal symbols
10   should be hidden and in the implementation reserved namespace according to
11   ISO C and POSIX rules. If possible the built shared libraries and static
12   library archives should be usable to override libc symbols at link time (or
13   at runtime via LD_PRELOAD). This requires the symbols to follow the glibc ABI
14   (other than symbol versioning), this cannot be done reliably for static
15   linking so this is a best effort requirement.
16
173. API: include headers should be suitable for benchmarking and testing code
18   and should not conflict with libc headers.
19
20
21CONTRIBUTION GUIDELINES FOR string SUB-DIRECTORY
22================================================
231. Code:
24   - The assumptions of the code must be clearly documented.
25
26   - Assembly style should be consistent across different implementations.
27
28
292. Performance:
30   - Benchmarking is needed on several microarchitectures.
31