Skip to content

Commit 36c6f99

Browse files
committed
SIL: Improve comments of MemoryLocations and MemoryVerifier
1 parent 74151a9 commit 36c6f99

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

include/swift/SIL/MemoryLocations.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ void dumpBits(const SmallBitVector &bits);
4343
///
4444
/// Memory locations are limited to addresses which are guaranteed to
4545
/// be not aliased, like @in/inout parameters and alloc_stack.
46-
/// Currently only a certain set of address instructions are supported:
47-
/// Specifically those instructions which are going to be included when SIL
48-
/// supports opaque values.
46+
/// Currently only a certain set of address instructions are supported, for
47+
/// details see `MemoryLocations::analyzeLocationUsesRecursively` and
48+
/// `MemoryLocations::analyzeAddrProjection`.
4949
class MemoryLocations {
5050
public:
5151

@@ -288,7 +288,7 @@ class MemoryLocations {
288288
/// not covered by sub-fields.
289289
const Bits &getNonTrivialLocations();
290290

291-
/// Debug dump the MemoryLifetime internals.
291+
/// Debug dump the MemoryLocations internals.
292292
void dump() const;
293293

294294
private:

lib/SIL/Verifier/MemoryLifetimeVerifier.cpp

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,8 @@ namespace {
3131
/// A utility for verifying memory lifetime.
3232
///
3333
/// The MemoryLifetime utility checks the lifetime of memory locations.
34-
/// This is limited to memory locations which are guaranteed to be not aliased,
35-
/// like @in or @inout parameters. Also, alloc_stack locations are handled.
36-
///
37-
/// In addition to verification, the MemoryLifetime class can be used as utility
38-
/// (e.g. base class) for optimizations, which need to compute memory lifetime.
34+
/// This is limited to memory locations which can be handled by
35+
/// `MemoryLocations`.
3936
class MemoryLifetimeVerifier {
4037

4138
using Bits = MemoryLocations::Bits;

0 commit comments

Comments
 (0)