aboutsummaryrefslogtreecommitdiff
path: root/API-CONVENTIONS.md
AgeCommit message (Collapse)AuthorFilesLines
2024-04-25Discuss pointer rules in even more detail in API-CONVENTIONSDavid Benjamin1-8/+71
This covers: - The empty slices mess, and specifically Rust's unsafe FFIs - Whether objects may be NULL by default - When we use C's array syntax for static lengths Also remove the note about ASN.1 and X.509 APIs being undocumented. We've now documented them. Change-Id: Ie12eee5ec16b9f87790076cbbe3a269f288dda03 Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/68047 Reviewed-by: Adam Langley <agl@google.com> Reviewed-by: Bob Beck <bbe@google.com> Commit-Queue: David Benjamin <davidben@google.com>
2024-02-23Make an include/openssl/experimental. Move kyber to it for now.Bob Beck1-0/+3
Update-Note: <openssl/kyber.h> has moved to <openssl/experimental/kyber.h> Change-Id: I51d37aeb2b6cfbbaae494cc38f1b0a82669d2692 Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/66467 Reviewed-by: David Benjamin <davidben@google.com> Auto-Submit: Bob Beck <bbe@google.com> Commit-Queue: Bob Beck <bbe@google.com>
2023-11-30Use relative links in markdown filesDavid Benjamin1-1/+1
Our repository is sometimes copied into other repositories, at which point all the absolute links don't work. README.md used "./whatever", which seems to work most consistently, so copy that. Change-Id: I63bbf01b8f3870112d1df571adaa6cc82f58e5eb Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/64347 Commit-Queue: David Benjamin <davidben@google.com> Auto-Submit: David Benjamin <davidben@google.com> Commit-Queue: Bob Beck <bbe@google.com> Reviewed-by: Hubert Chao <hchao@google.com> Reviewed-by: Bob Beck <bbe@google.com>
2018-09-05Clarify "reference" and fix typo.David Benjamin1-9/+14
It was pointed out that "a reference" to C++ programmers means something very different from what we intend. Change-Id: I508196f8e3427ea71439c7871eae9b735a4fa5ca Reviewed-on: https://boringssl-review.googlesource.com/31544 Reviewed-by: Adam Langley <agl@google.com>
2018-09-04Add some about ownership to API-CONVENTIONS.David Benjamin1-1/+60
In particular, we often don't say anything if using the "default" conventions, but we don't say what those are. We've also never documented get0/get1/set0/set1. Change-Id: I113593cfcdcb93e0009796649e4c19219e765caf Reviewed-on: https://boringssl-review.googlesource.com/31504 Commit-Queue: David Benjamin <davidben@google.com> CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org> Reviewed-by: Adam Langley <agl@google.com>
2017-01-04Fix API-CONVENTIONS.md typos.David Benjamin1-2/+2
Change-Id: Iba299b1bcfe7de53bb0fa6b6cc4e607129905fd0 Reviewed-on: https://boringssl-review.googlesource.com/13054 Commit-Queue: David Benjamin <davidben@google.com> Reviewed-by: Adam Langley <agl@google.com>
2016-09-13Update API-CONVENTIONS.md for the new scopers.David Benjamin1-22/+17
Change-Id: Ic28156544d7c0b468022c0cf3b36c781a4ec8036 Reviewed-on: https://boringssl-review.googlesource.com/10860 Reviewed-by: Matt Braithwaite <mab@google.com> Commit-Queue: David Benjamin <davidben@google.com> CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
2016-09-01Replace Scoped* heap types with bssl::UniquePtr.Matt Braithwaite1-2/+2
Unlike the Scoped* types, bssl::UniquePtr is available to C++ users, and offered for a large variety of types. The 'extern "C++"' trick is used to make the C++ bits digestible to C callers that wrap header files in 'extern "C"'. Change-Id: Ifbca4c2997d6628e33028c7d7620c72aff0f862e Reviewed-on: https://boringssl-review.googlesource.com/10521 Reviewed-by: David Benjamin <davidben@google.com> Commit-Queue: David Benjamin <davidben@google.com> CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
2016-08-04Add an API-CONVENTIONS.md document.David Benjamin1-0/+189
We're starting to get quite a lot of these ALL-CAPS.md documents. There's been enough questions around how to properly use types like EVP_MD_CTX that we probably should write down some of these common rules. Change-Id: I125f4e82efb168a071b54ff76c5af34c42ff4800 Reviewed-on: https://boringssl-review.googlesource.com/9115 Reviewed-by: Adam Langley <agl@google.com>