Skip to content

Commit

Permalink
Update the S_IFMT godoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
puellanivis authored Apr 8, 2024
1 parent 3c39a36 commit c194b63
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion stat.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,10 @@ const (
s_ISVTX = uint32(sshfx.ModeSticky)
)

// S_IFMT is a legacy export. `sshfx.ModeType` should be used instead
// S_IFMT is a legacy export, and was brought in to support GOOS environments whose sysconfig.S_IFMT may be different from the value used internally by SFTP standards.
// There should be no reason why you need to import it, or use it, but unexporting it could cause code to break in a way that cannot be readily fixed.
// As such, we continue to export this value as the value used in the SFTP standard.
//
// Deprecated: Remove use of this value, and avoid any future use as well.
// There is no alternative provided, you should never need to access this value.
const S_IFMT = uint32(sshfx.ModeType)

0 comments on commit c194b63

Please sign in to comment.