go/src/weak/doc.go

// Copyright 2024 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

/*
Package weak provides ways to safely reference memory weakly,
that is, without preventing its reclamation.
*/
package weak
weak: move internal/weak to weak, and update according to proposal The updates are: - API documentation changes. - Removal of the old package documentation discouraging linkname. - Addition of new package documentation with some advice. - Renaming of weak.Pointer.Strong -> weak.Pointer.Value. Fixes #67552. Change-Id: Ifad7e629b6d339dacaf2ca37b459d7f903e31bf8 Reviewed-on: https://go-review.googlesource.com/c/go/+/628455 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Carlos Amedee <carlos@golang.org> Auto-Submit: Michael Knyszek <mknyszek@google.com> 2024-11-15 20:42:32 +00:00			`// Copyright 2024 The Go Authors. All rights reserved.`
			`// Use of this source code is governed by a BSD-style`
			`// license that can be found in the LICENSE file.`

			`/*`
weak: align weak.Pointer documentation with runtime.AddCleanup In hindsight, I think the "advice" I wrote is a bit heavy-handed and better suited for something like the GC guide. Listing the use-cases seems good, and all the possible things that go wrong seems to do the trick in terms of deterrence, like it does with finalizers. Also, include some points I missed, like the tiny allocator warning and the fact that weak pointers are not guaranteed to ever return nil. Also, a lot of this actually shouldn't have been in the package docs. Many of the warnings only apply to weak pointers, but not other data structures that may live in this package in the future, like weak-keyed maps. Change-Id: Id245661540ffd93de4b727cd272284491d085c1e Reviewed-on: https://go-review.googlesource.com/c/go/+/634376 Reviewed-by: Carlos Amedee <carlos@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Michael Knyszek <mknyszek@google.com> 2024-12-07 02:58:00 +00:00			`Package weak provides ways to safely reference memory weakly,`
			`that is, without preventing its reclamation.`
weak: move internal/weak to weak, and update according to proposal The updates are: - API documentation changes. - Removal of the old package documentation discouraging linkname. - Addition of new package documentation with some advice. - Renaming of weak.Pointer.Strong -> weak.Pointer.Value. Fixes #67552. Change-Id: Ifad7e629b6d339dacaf2ca37b459d7f903e31bf8 Reviewed-on: https://go-review.googlesource.com/c/go/+/628455 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Carlos Amedee <carlos@golang.org> Auto-Submit: Michael Knyszek <mknyszek@google.com> 2024-11-15 20:42:32 +00:00			`*/`
			`package weak`