Skip to content

Commit 29eb4ea

Browse files
add allocation release note and fix rst quotes
1 parent 50b1f28 commit 29eb4ea

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

clang/docs/ReleaseNotes.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,9 +327,9 @@ Non-comprehensive list of changes in this release
327327
``__reference_constructs_from_temporary`` should be used instead. (#GH44056)
328328
- Added `__builtin_get_vtable_pointer` to directly load the primary vtable pointer from a
329329
polymorphic object.
330-
- `libclang` receives a family of new bindings to query basic facts about
331-
GCC-style inline assembly blocks, including whether the block is `volatile`
332-
and its template string following the LLVM IR `asm` format. (#GH143424)
330+
- ``libclang`` receives a family of new bindings to query basic facts about
331+
GCC-style inline assembly blocks, including whether the block is ``volatile``
332+
and its template string following the LLVM IR ``asm`` format. (#GH143424)
333333
- Clang no longer rejects reinterpret_cast conversions between indirect
334334
ARC-managed pointers and other pointer types. The prior behavior was overly
335335
strict and inconsistent with the ARC specification.

clang/include/clang-c/Index.h

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4521,14 +4521,17 @@ CINDEX_LINKAGE CXStringSet *clang_Cursor_getObjCManglings(CXCursor);
45214521
*
45224522
* This function also returns a valid empty string if the cursor does not point
45234523
* at a GCC inline assembly block.
4524+
*
4525+
* Users are responsible for releasing the allocation of returned string via
4526+
* \c clang_disposeString.
45244527
*/
45254528

45264529
CINDEX_LINKAGE CXString clang_Cursor_getGCCAssemblyTemplate(CXCursor);
45274530

45284531
/**
45294532
* Given a CXCursor_GCCAsmStmt cursor, check if the assembly block has goto
45304533
* labels.
4531-
* This function also returns FALSE if the cursor does not point at a GCC inline
4534+
* This function also returns 0 if the cursor does not point at a GCC inline
45324535
* assembly block.
45334536
*/
45344537

@@ -4553,11 +4556,14 @@ CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyNumInputs(CXCursor);
45534556
/**
45544557
* Given a CXCursor_GCCAsmStmt cursor, get the constraint and expression cursor
45554558
* to the Index-th input.
4556-
* This function returns TRUE when the cursor points at a GCC inline assembly
4559+
* This function returns 1 when the cursor points at a GCC inline assembly
45574560
* statement, `Index` is within bounds and both the `Constraint` and `Expr` are
45584561
* not NULL.
4559-
* Otherwise, this function returns FALSE but leaves `Constraint` and `Expr`
4562+
* Otherwise, this function returns 0 but leaves `Constraint` and `Expr`
45604563
* intact.
4564+
*
4565+
* Users are responsible for releasing the allocation of `Constraint` via
4566+
* \c clang_disposeString.
45614567
*/
45624568

45634569
CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyInput(CXCursor Cursor,
@@ -4568,11 +4574,14 @@ CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyInput(CXCursor Cursor,
45684574
/**
45694575
* Given a CXCursor_GCCAsmStmt cursor, get the constraint and expression cursor
45704576
* to the Index-th output.
4571-
* This function returns TRUE when the cursor points at a GCC inline assembly
4577+
* This function returns 1 when the cursor points at a GCC inline assembly
45724578
* statement, `Index` is within bounds and both the `Constraint` and `Expr` are
45734579
* not NULL.
4574-
* Otherwise, this function returns FALSE but leaves `Constraint` and `Expr`
4580+
* Otherwise, this function returns 0 but leaves `Constraint` and `Expr`
45754581
* intact.
4582+
*
4583+
* Users are responsible for releasing the allocation of `Constraint` via
4584+
* \c clang_disposeString.
45764585
*/
45774586

45784587
CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyOutput(CXCursor Cursor,
@@ -4592,6 +4601,9 @@ CINDEX_LINKAGE unsigned clang_Cursor_getGCCAssemblyNumClobbers(CXCursor Cursor);
45924601
* Given a CXCursor_GCCAsmStmt cursor, get the Index-th clobber of it.
45934602
* This function returns a valid empty string if the cursor does not point
45944603
* at a GCC inline assembly block or `Index` is out of bounds.
4604+
*
4605+
* Users are responsible for releasing the allocation of returned string via
4606+
* \c clang_disposeString.
45954607
*/
45964608

45974609
CINDEX_LINKAGE CXString clang_Cursor_getGCCAssemblyClobber(CXCursor Cursor,
@@ -4600,7 +4612,7 @@ CINDEX_LINKAGE CXString clang_Cursor_getGCCAssemblyClobber(CXCursor Cursor,
46004612
/**
46014613
* Given a CXCursor_GCCAsmStmt cursor, check if the inline assembly is
46024614
* `volatile`.
4603-
* This function returns FALSE if the cursor does not point at a GCC inline
4615+
* This function returns 0 if the cursor does not point at a GCC inline
46044616
* assembly block.
46054617
*/
46064618

0 commit comments

Comments
 (0)