Skip to content

Commit d4795ce

Browse files
kolyshkinLuap99
authored andcommitted
Fix doc references
Some documentation references are not correct and thus they are not rendered as links. Fix those. Tested locally with godoc. Signed-off-by: Kir Kolyshkin <[email protected]>
1 parent abb50b3 commit d4795ce

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

dbus/methods.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"github.com/godbus/dbus/v5"
2525
)
2626

27-
// Who specifies which process to send a signal to via the [KillUnitWithTarget].
27+
// Who specifies which process to send a signal to via the [Conn.KillUnitWithTarget].
2828
type Who string
2929

3030
const (
@@ -196,15 +196,15 @@ func (c *Conn) StartTransientUnitContext(ctx context.Context, name string, mode
196196
return c.startJob(ctx, ch, "org.freedesktop.systemd1.Manager.StartTransientUnit", name, mode, properties, make([]PropertyCollection, 0))
197197
}
198198

199-
// Deprecated: use [KillUnitWithTarget] instead.
199+
// Deprecated: use [Conn.KillUnitWithTarget] instead.
200200
func (c *Conn) KillUnit(name string, signal int32) {
201201
c.KillUnitContext(context.Background(), name, signal)
202202
}
203203

204204
// KillUnitContext takes the unit name and a UNIX signal number to send.
205205
// All of the unit's processes are killed.
206206
//
207-
// Deprecated: use [KillUnitWithTarget] instead, with target argument set to [All].
207+
// Deprecated: use [Conn.KillUnitWithTarget] instead, with target argument set to [All].
208208
func (c *Conn) KillUnitContext(ctx context.Context, name string, signal int32) {
209209
_ = c.KillUnitWithTarget(ctx, name, All, signal)
210210
}
@@ -859,7 +859,7 @@ func (c *Conn) listJobsInternal(ctx context.Context) ([]JobStatus, error) {
859859
}
860860

861861
// FreezeUnit freezes the cgroup associated with the unit.
862-
// Note that FreezeUnit and [ThawUnit] are only supported on systems running with cgroup v2.
862+
// Note that FreezeUnit and [Conn.ThawUnit] are only supported on systems running with cgroup v2.
863863
func (c *Conn) FreezeUnit(ctx context.Context, unit string) error {
864864
return c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.FreezeUnit", 0, unit).Store()
865865
}

dbus/subscription.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func (c *Conn) SubscribeUnitsCustom(interval time.Duration, buffer int, isChange
111111
return c.SubscribeUnitsCustomContext(context.Background(), interval, buffer, isChanged, filterUnit)
112112
}
113113

114-
// SubscribeUnitsCustomContext is like [SubscribeUnitsContext] but lets you specify the buffer
114+
// SubscribeUnitsCustomContext is like [Conn.SubscribeUnitsContext] but lets you specify the buffer
115115
// size of the channels, the comparison function for detecting changes and a filter
116116
// function for cutting down on the noise that your channel receives.
117117
func (c *Conn) SubscribeUnitsCustomContext(ctx context.Context, interval time.Duration, buffer int, isChanged func(*UnitStatus, *UnitStatus) bool, filterUnit func(string) bool) (<-chan map[string]*UnitStatus, <-chan error) {

sdjournal/journal.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
// systemd journal wrapped around the sd-journal C API.
1818
//
1919
// All public read methods map closely to the sd-journal API functions. See the
20-
// sd-journal.h documentation[1] for information about each function.
20+
// [sd-journal.h documentation] for information about each function.
2121
//
22-
// To write to the journal, see the pure-Go "journal" package
22+
// To write to the journal, see the pure-Go "journal" package.
2323
//
24-
// [1] http://www.freedesktop.org/software/systemd/man/sd-journal.html
24+
// [sd-journal.h documentation]: http://www.freedesktop.org/software/systemd/man/sd-journal.html
2525
package sdjournal
2626

2727
// #include <systemd/sd-journal.h>

0 commit comments

Comments
 (0)