Skip to content

Commit 9b80ac5

Browse files
committed
Document API stability
1 parent 88c6bcf commit 9b80ac5

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ Package vss exposes Windows Volume Shadow Copy API.
99
```
1010
go get github.com/mxk/go-vss
1111
```
12+
13+
The current v1 API is stable and production-ready. It is based on the WMI [Win32_ShadowCopy] class.
14+
15+
[Win32_ShadowCopy]: https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/aa394428(v=vs.85)

vss.go

+2
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ func SplitVolume(name string) (vol, rel string, err error) {
118118
}
119119

120120
// ShadowCopy is an instance of Win32_ShadowCopy class. See:
121+
//
121122
// https://learn.microsoft.com/en-us/previous-versions/windows/desktop/legacy/aa394428(v=vs.85)
122123
type ShadowCopy struct {
123124
ID string
@@ -259,6 +260,7 @@ var isAdmin = sync.OnceValue(func() bool {
259260
})
260261

261262
// CreateError is an error code returned by Win32_ShadowCopy.Create. See:
263+
//
262264
// https://learn.microsoft.com/en-us/previous-versions/windows/desktop/vsswmi/create-method-in-class-win32-shadowcopy#return-value
263265
type CreateError uint32
264266

0 commit comments

Comments
 (0)